pharmaobservatory 0.1.6 → 0.1.7

data/docs/LegalEntitiesRecordAttributes.md

@@ -4,6 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **ownership_percentages** | [**OwnershipPercentagesRow**](OwnershipPercentagesRow.md) |  | [optional] |
 | **sponsor_recruitment_duration** | [**SponsorRecruitmentDurationRow**](SponsorRecruitmentDurationRow.md) |  | [optional] |
 
 ## Example
@@ -12,6 +13,7 @@
 require 'pharmaobservatory'
 
 instance = PharmaObservatory::LegalEntitiesRecordAttributes.new(
+  ownership_percentages: null,
   sponsor_recruitment_duration: null
 )
 ```

data/docs/OrgRelationshipsRow.md

@@ -29,7 +29,7 @@
 | **last_observed_at** | **Time** | When the latest of the edge's records was observed in the source. | [optional] |
 | **license_name** | **String** | The licence of the source behind the edge. | [optional] |
 | **attribution** | **String** | The credit line the source requires for the edge. Show it wherever the edge is shown: the Charity Commission and UK Research and Innovation edges require it under the Open Government Licence v3.0. | [optional] |
-| **restriction_tier** | **String** | Always none: every source behind these edges is open, and a test on the source assertions reports any restricted source that is ever added. | [optional] |
+| **restriction_tier** | **String** | The tier vocabulary is none or licensable. Every row here is none: every source behind these edges is open, and a test on the source assertions reports any restricted source that is ever added. | [optional] |
 
 ## Example
 

data/docs/OwnershipPercentagesResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::OwnershipPercentagesResponse
+
+## 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<OwnershipPercentagesRow>**](OwnershipPercentagesRow.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::OwnershipPercentagesResponse.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/OwnershipPercentagesRow.md

@@ -0,0 +1,74 @@
+# PharmaObservatory::OwnershipPercentagesRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subject_org_id** | **String** | Legal-entity level: the subject organization's record, a resolution root (the identity every ownership dataset keys on). One row per organization; an insider row with no organization has no row here. | [optional] |
+| **subject_company_id** | **String** | Company level: the subject organization's company (null when the organization does not resolve to a company). | [optional] |
+| **subject_company_name** | **String** | Display name of the subject organization's company. | [optional] |
+| **subject_group_id** | **String** | Group level: the subject organization's current ultimate parent company; a root company's group is itself. | [optional] |
+| **subject_group_name** | **String** | Display name of the subject organization's group. | [optional] |
+| **any_ownership_source** | **Boolean** | True when an insider row or a Form 13F quarter exists for the organization. | [optional] |
+| **shares_outstanding_state** | **String** | reported when the organization has a cover-page share count on file, not_reported when it has none (then no percentage is taken and the share figures are shown instead). | [optional] |
+| **shares_outstanding** | **Float** | The denominator both percentages divide into: the latest cover-page share count (dei:EntityCommonStockSharesOutstanding) from an annual form. It is measured on the filing's cover date, 0 to 3 months after the fiscal period end, and the cover date is not published, so its vintage is the fiscal year in shares_outstanding_fy. | [optional] |
+| **shares_outstanding_fy** | **Integer** | The fiscal year of the filing the share count comes from. | [optional] |
+| **shares_outstanding_concept** | **String** | The XBRL (eXtensible Business Reporting Language) concept the share count is read from. Always dei:EntityCommonStockSharesOutstanding. | [optional] |
+| **insider_state** | **String** | How the insider figure was reached. reported: The sum of the current non-derivative balance each reporting owner last filed on a Form 3, 4 or 5, divided by the share count on file. no_insider_filing: No Form 3, 4 or 5 in our data names an insider of this company. That is a statement about coverage, not a statement that insiders hold nothing. all_positions_closed: Every insider position on file has been reported closed. This is a filed zero, not missing data. derivative_only: The insiders on file hold only derivative positions (options and similar), which are not outstanding shares. This is a filed zero, not missing data. no_denominator: No percentage: this company's SEC filings in our data carry no cover-page share count, so there is no denominator to divide by. The share count on file is shown instead. not_computable: No percentage is taken here. The reported share total is given instead, with the reason no ratio is taken. | [optional] |
+| **insider_reason** | **String** | Why an insider ratio was not taken when insider_state is not_computable. denominator_stale: The share count on file is more than two years older than the positions it would be divided into, so the ratio would not describe this company. exceeds_shares_outstanding: The insider total on file is larger than the company's whole share count, which is arithmetically impossible for a single source and means the filings behind it have not consolidated correctly. Null otherwise. | [optional] |
+| **insider_percent** | **Float** | The share of shares outstanding held by Form 3, 4 and 5 insiders (insider_shares divided by shares_outstanding, times 100, unrounded); null unless insider_state is reported. | [optional] |
+| **insider_shares** | **Float** | The sum of the current non-derivative balance each reporting insider last filed. A ceased or options-only insider adds nothing to it. Null when no insider holds standing shares. | [optional] |
+| **insider_owner_count** | **Integer** | Insiders on file for the organization (0 when none). | [optional] |
+| **insider_standing_owner_count** | **Integer** | Insiders with a positive standing equity balance, the only population insider_shares describes. | [optional] |
+| **insider_closed_owner_count** | **Integer** | Insiders whose standing equity balance is zero or absent: closed positions plus options-only insiders. | [optional] |
+| **insider_derivative_only_owner_count** | **Integer** | Of the closed insiders, those whose only remaining positions are derivatives (options and similar), which are not outstanding shares. | [optional] |
+| **insider_last_filing_date** | **Date** | The latest filing date among the organization's insider rows. | [optional] |
+| **institutional_state** | **String** | How the institutional figure was reached. reported: Every position reported on Form 13F for the quarter shown, summed once per filing manager, against the same share count as the insider figure. exceeds_outstanding: Reported positions exceed the shares outstanding on file. Shown as filed. implausible: No percentage: reported positions exceed 1.5 times the shares outstanding on file, which indicates a corporate action or a denominator mismatch rather than ownership. no_13f_issuer: No Form 13F issuer resolved to this company in any quarter. Positions are reported against a SECURITY, so this is a statement about the CUSIP-to-company bridge, not about institutional interest. no_reference_period: No manager reported this company for the most recent fully-reported quarter. Positions in earlier quarters are on file and are reported per manager, but a manager whose newest filing is for an older quarter is not a current holder and is not counted here. no_reference_shares: No manager reported an equity position in this company for the most recent fully-reported quarter. Only options, debt or non-equity issues were reported, and none of those is a share count. no_denominator: No percentage: this company's SEC filings in our data carry no cover-page share count, so there is no denominator to divide by. The reported share total is shown instead. not_computable: No percentage is taken here. The reported share total is given instead, with the reason no ratio is taken. | [optional] |
+| **institutional_reason** | **String** | Why an institutional ratio was not taken when institutional_state is not_computable. denominator_stale: The share count on file is more than two years older than the positions it would be divided into, so the ratio would not describe this company. Null otherwise. | [optional] |
+| **institutional_percent** | **Float** | The share of shares outstanding under reported institutional discretion at the reference quarter (institutional_shares_reported divided by shares_outstanding, times 100, unrounded, as filed and never capped); null unless institutional_state is reported or exceeds_outstanding. | [optional] |
+| **institutional_shares_reported** | **Float** | The shares reported on Form 13F at the reference quarter, counted equity positions only, summed once per filing manager. Null when the organization has no reference-quarter row. | [optional] |
+| **institutional_manager_count** | **Integer** | Managers reporting a counted equity position at the reference quarter (0 when there is no reference-quarter row). | [optional] |
+| **institutional_report_period** | **Date** | The reference quarter end the institutional figure is measured at: the most recent quarter in which at least 80 percent of the prior quarter's filing managers had filed. | [optional] |
+| **institutional_shares_otr** | **Float** | Of institutional_shares_reported, the shares under other (OTR) discretion. | [optional] |
+| **institutional_shares_excluded_non_equity_issue** | **Float** | Shares reported against convertible notes, debt and preferred issues at the reference quarter, excluded from institutional_shares_reported. | [optional] |
+| **institutional_equity_cusip_count** | **Integer** | Distinct equity CUSIPs (Committee on Uniform Securities Identification Procedures identifiers) counted at the reference quarter (0 when there is no reference-quarter row). | [optional] |
+| **institutional_latest_filing_date** | **Date** | The latest Form 13F filing date among the reference quarter's positions. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::OwnershipPercentagesRow.new(
+  subject_org_id: null,
+  subject_company_id: null,
+  subject_company_name: null,
+  subject_group_id: null,
+  subject_group_name: null,
+  any_ownership_source: null,
+  shares_outstanding_state: null,
+  shares_outstanding: null,
+  shares_outstanding_fy: null,
+  shares_outstanding_concept: null,
+  insider_state: null,
+  insider_reason: null,
+  insider_percent: null,
+  insider_shares: null,
+  insider_owner_count: null,
+  insider_standing_owner_count: null,
+  insider_closed_owner_count: null,
+  insider_derivative_only_owner_count: null,
+  insider_last_filing_date: null,
+  institutional_state: null,
+  institutional_reason: null,
+  institutional_percent: null,
+  institutional_shares_reported: null,
+  institutional_manager_count: null,
+  institutional_report_period: null,
+  institutional_shares_otr: null,
+  institutional_shares_excluded_non_equity_issue: null,
+  institutional_equity_cusip_count: null,
+  institutional_latest_filing_date: null
+)
+```
+

data/docs/PdufaDatesRow.md

@@ -16,7 +16,7 @@
 | **event_category** | **String** | Event category (pdufa, adcomm and so on). | [optional] |
 | **drug_name** | **String** | The drug name as filed. | [optional] |
 | **drug_id** | **String** | The drug key. | [optional] |
-| **molecule_id** | **String** | The molecule key. | [optional] |
+| **molecule_id** | **String** | The molecule key, the resolved drug of the calendar entry and the entry key for the drugs object type (null when the drug name did not resolve to a drug). | [optional] |
 | **sponsor_name** | **String** | The sponsor name as filed. | [optional] |
 | **sponsor_org_id** | **String** | Legal-entity level: the organization record the sponsor resolved to (null when unresolved). | [optional] |
 | **sponsor_company_id** | **String** | Company level: the company the sponsor belongs to (null when unresolved). | [optional] |

data/docs/ProgramLicensingCandidatesResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::ProgramLicensingCandidatesResponse
+
+## 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<ProgramLicensingCandidatesRow>**](ProgramLicensingCandidatesRow.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::ProgramLicensingCandidatesResponse.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/ProgramLicensingCandidatesRow.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::ProgramLicensingCandidatesRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sponsor_org_id** | **String** | Legal-entity level: the lead sponsor's organization record. | [optional] |
+| **sponsor_name** | **String** | The sponsor's organization name. | [optional] |
+| **sponsor_company_id** | **String** | Company level: the sponsor's company (null when unresolved). | [optional] |
+| **sponsor_company_name** | **String** | Display name of the sponsor's company. | [optional] |
+| **sponsor_group_id** | **String** | Group level: the sponsor's current ultimate parent; a root's group is itself. | [optional] |
+| **sponsor_group_name** | **String** | Display name of the sponsor's group. | [optional] |
+| **drug_id** | **String** | The drug key. | [optional] |
+| **drug_name** | **String** | The drug's name. | [optional] |
+| **condition_id** | **String** | The condition key, a MeSH (Medical Subject Headings) descriptor id (D followed by six to nine digits). | [optional] |
+| **condition_name** | **String** | The condition's name. | [optional] |
+| **condition_ancestor_ids** | **Array<String>** | Every MeSH descriptor id at or above the condition in the tree, the condition itself included. Filter a subtree with = ANY. | [optional] |
+| **max_phase** | **Integer** | Highest phase reached: 0 early phase 1 through 6 for phase 4 (marketed); -1 when unstated. | [optional] |
+| **n_trials** | **Integer** | Lead-sponsored trials in the program. | [optional] |
+| **n_active** | **Integer** | Of those, trials in an active status. | [optional] |
+| **last_year** | **Integer** | Latest trial start year. | [optional] |
+| **last_update_year** | **Integer** | Year the program's most recently updated trial record was posted. | [optional] |
+| **withdrawn** | **Boolean** | True when the drug has been withdrawn. | [optional] |
+| **cause_name** | **String** | The Global Burden of Disease cause matched to the condition. | [optional] |
+| **dalys_millions** | **Float** | Global disability-adjusted life years for the matched cause, in millions. | [optional] |
+| **deaths_millions** | **Float** | Global deaths for the matched cause, in millions. | [optional] |
+| **druggability** | **Integer** | Druggability class of the matched cause: 1 highly druggable, 2 druggable, 3 challenging, 4 very challenging. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ProgramLicensingCandidatesRow.new(
+  sponsor_org_id: null,
+  sponsor_name: null,
+  sponsor_company_id: null,
+  sponsor_company_name: null,
+  sponsor_group_id: null,
+  sponsor_group_name: null,
+  drug_id: null,
+  drug_name: null,
+  condition_id: null,
+  condition_name: null,
+  condition_ancestor_ids: null,
+  max_phase: null,
+  n_trials: null,
+  n_active: null,
+  last_year: null,
+  last_update_year: null,
+  withdrawn: null,
+  cause_name: null,
+  dalys_millions: null,
+  deaths_millions: null,
+  druggability: null
+)
+```
+

data/docs/ProgramsResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::ProgramsResponse
+
+## 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<ProgramsRow>**](ProgramsRow.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::ProgramsResponse.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/ProgramsRow.md

@@ -0,0 +1,46 @@
+# PharmaObservatory::ProgramsRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **program_id** | **String** | The program key: a hash of drug_id and condition_id, one value per row. | [optional] |
+| **drug_id** | **String** | The drug key of the program, the drug record the trials name (a salt form or a trial arm is its own record). | [optional] |
+| **molecule_id** | **String** | The molecule key: the resolved drug the program's drug record folds to, and the entry key for the drugs object type. | [optional] |
+| **drug_name** | **String** | The drug's name. | [optional] |
+| **condition_id** | **String** | The condition key, a MeSH (Medical Subject Headings) descriptor id (D followed by six to nine digits). | [optional] |
+| **condition_name** | **String** | The condition's name. | [optional] |
+| **is_indication** | **Boolean** | True for a specific disease, false for a broad MeSH umbrella condition. | [optional] |
+| **max_phase** | **Integer** | Highest phase reached across the program's trials: 0 not reported, 1 through 4 for phase 1 through phase 4 (the 0 to 4 scale; see caveats). | [optional] |
+| **n_trials** | **Integer** | Distinct trials of the program, across all sponsors. | [optional] |
+| **n_completed** | **Integer** | Of those, trials with status completed. | [optional] |
+| **n_terminated** | **Integer** | Of those, trials with status terminated. | [optional] |
+| **first_year** | **Integer** | Earliest plausible trial start year. | [optional] |
+| **last_year** | **Integer** | Latest plausible trial completion or start year. | [optional] |
+| **n_sponsor_companies** | **Integer** | Distinct lead-sponsor companies across the program's trials; an unresolved lead sponsor counts as itself. | [optional] |
+| **dalys_millions** | **Float** | Disability-adjusted life years (DALYs, millions) of the condition's global burden, from the Global Burden of Disease (GBD) 2021 study of the Institute for Health Metrics and Evaluation (IHME). Null for a caller without the licence for this column; see withheld_columns. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ProgramsRow.new(
+  program_id: null,
+  drug_id: null,
+  molecule_id: null,
+  drug_name: null,
+  condition_id: null,
+  condition_name: null,
+  is_indication: null,
+  max_phase: null,
+  n_trials: null,
+  n_completed: null,
+  n_terminated: null,
+  first_year: null,
+  last_year: null,
+  n_sponsor_companies: null,
+  dalys_millions: null
+)
+```
+

data/docs/RareDiseaseGenesResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::RareDiseaseGenesResponse
+
+## 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<RareDiseaseGenesRow>**](RareDiseaseGenesRow.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::RareDiseaseGenesResponse.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/RareDiseaseGenesRow.md

@@ -0,0 +1,50 @@
+# PharmaObservatory::RareDiseaseGenesRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **gene_assertion_id** | **String** | The identifier of the disease-gene assertion. | [optional] |
+| **orpha_code** | **String** | The ORPHA code of the disease, the digits in the web page address (/rare-diseases/558). The entry key of the rare_diseases object type. | [optional] |
+| **gene_symbol** | **String** | The gene symbol as Orphadata gives it. | [optional] |
+| **gene_name** | **String** | The gene's full name. | [optional] |
+| **gene_type** | **String** | The gene type Orphadata records (for example gene_with_protein_product). | [optional] |
+| **association_type** | **String** | The association Orphadata asserts between the gene and the disease, for example a disease-causing germline mutation or a modifying germline mutation. | [optional] |
+| **association_status** | **String** | assessed when Orphanet has assessed the association, not_yet_assessed otherwise. | [optional] |
+| **is_known_causal** | **Boolean** | True for an assessed disease-causing mutation assertion. | [optional] |
+| **ensembl_id** | **String** | The Ensembl gene id Orphadata gives for the gene. | [optional] |
+| **ncbi_gene_id** | **String** | The NCBI Gene id Orphadata gives for the gene. | [optional] |
+| **target_id** | **String** | The Ensembl gene id of the matching row in the targets dataset; null when the gene has no row there. | [optional] |
+| **gene_resolution_status** | **String** | How the gene's Ensembl and NCBI identifiers resolved against the gene spine. | [optional] |
+| **gene_identifier_conflict** | **Boolean** | True when the identifiers on the assertion disagree with the gene spine. | [optional] |
+| **source_release** | **String** | The Orphadata Science release the row was read from. | [optional] |
+| **source_url** | **String** | The URL of the source file the row was read from. | [optional] |
+| **license_name** | **String** | The licence of the Orphadata Science file. | [optional] |
+| **attribution** | **String** | The attribution line the source requires; quote it with any figure taken from the row. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::RareDiseaseGenesRow.new(
+  gene_assertion_id: null,
+  orpha_code: null,
+  gene_symbol: null,
+  gene_name: null,
+  gene_type: null,
+  association_type: null,
+  association_status: null,
+  is_known_causal: null,
+  ensembl_id: null,
+  ncbi_gene_id: null,
+  target_id: null,
+  gene_resolution_status: null,
+  gene_identifier_conflict: null,
+  source_release: null,
+  source_url: null,
+  license_name: null,
+  attribution: null
+)
+```
+

data/docs/RareDiseaseHierarchyResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::RareDiseaseHierarchyResponse
+
+## 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<RareDiseaseHierarchyRow>**](RareDiseaseHierarchyRow.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::RareDiseaseHierarchyResponse.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/RareDiseaseHierarchyRow.md

@@ -0,0 +1,40 @@
+# PharmaObservatory::RareDiseaseHierarchyRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **hierarchy_assertion_id** | **String** | The identifier of the subclass assertion. | [optional] |
+| **orpha_code** | **String** | The ORPHA code of the child disease the assertion is entered on. | [optional] |
+| **preferred_name** | **String** | The child disease's preferred English name. | [optional] |
+| **parent_orpha_code** | **String** | The ORPHA code of the direct parent disease. | [optional] |
+| **parent_preferred_name** | **String** | The parent disease's preferred English name. | [optional] |
+| **parent_status** | **String** | The parent concept's lifecycle state. | [optional] |
+| **child_status** | **String** | The child concept's lifecycle state. | [optional] |
+| **predicate** | **String** | The relation asserted from child to parent (subclass_of). | [optional] |
+| **source_release** | **String** | The Orphadata Science release the row was read from. | [optional] |
+| **source_url** | **String** | The URL of the source file the row was read from. | [optional] |
+| **license_name** | **String** | The licence of the ontology release. | [optional] |
+| **attribution** | **String** | The attribution line the source requires; quote it with any figure taken from the row. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::RareDiseaseHierarchyRow.new(
+  hierarchy_assertion_id: null,
+  orpha_code: null,
+  preferred_name: null,
+  parent_orpha_code: null,
+  parent_preferred_name: null,
+  parent_status: null,
+  child_status: null,
+  predicate: null,
+  source_release: null,
+  source_url: null,
+  license_name: null,
+  attribution: null
+)
+```
+