RubyGems - pharmaobservatory - Versions diffs - 0.1.2 → 0.1.4 - Mend

pharmaobservatory 0.1.2 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (897) hide show

data/docs/LegalEntitiesRecord.md ADDED Viewed

@@ -0,0 +1,38 @@
+# PharmaObservatory::LegalEntitiesRecord
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object_type** | **String** |  |  |
+| **id** | **String** |  |  |
+| **record** | [**LegalEntitiesRow**](LegalEntitiesRow.md) |  |  |
+| **attributes** | [**LegalEntitiesRecordAttributes**](LegalEntitiesRecordAttributes.md) |  | [optional] |
+| **datasets** | [**Array&lt;DatasetListing&gt;**](DatasetListing.md) |  |  |
+| **attribution** | [**Array&lt;DatasetAttribution&gt;**](DatasetAttribution.md) |  | [optional] |
+| **source_credit** | **String** |  | [optional] |
+| **freshness** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash&lt;String, Object&gt;** |  | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::LegalEntitiesRecord.new(
+  object_type: null,
+  id: null,
+  record: null,
+  attributes: null,
+  datasets: null,
+  attribution: null,
+  source_credit: null,
+  freshness: null,
+  build: null,
+  build_state: null,
+  restriction: null
+)
+```

data/docs/LegalEntitiesRecordAttributes.md ADDED Viewed

@@ -0,0 +1,18 @@
+# PharmaObservatory::LegalEntitiesRecordAttributes
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sponsor_recruitment_duration** | [**SponsorRecruitmentDurationRow**](SponsorRecruitmentDurationRow.md) |  | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::LegalEntitiesRecordAttributes.new(
+  sponsor_recruitment_duration: null
+)
+```

data/docs/LegalEntitiesResponse.md ADDED Viewed

@@ -0,0 +1,58 @@
+# PharmaObservatory::LegalEntitiesResponse
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset** | **String** |  |  |
+| **grain** | **String** |  | [optional] |
+| **object_type** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **scope** | [**BiomarkerCdxAssertionsResponseScope**](BiomarkerCdxAssertionsResponseScope.md) |  | [optional] |
+| **columns** | [**Array&lt;DatasetColumn&gt;**](DatasetColumn.md) |  |  |
+| **rows** | [**Array&lt;LegalEntitiesRow&gt;**](LegalEntitiesRow.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&lt;String&gt;** |  | [optional] |
+| **filters** | **Array&lt;Hash&lt;String, Object&gt;&gt;** |  | [optional] |
+| **group_by** | **Array&lt;String&gt;** |  | [optional] |
+| **measures** | **Array&lt;String&gt;** |  | [optional] |
+| **attribution** | [**Array&lt;DatasetAttribution&gt;**](DatasetAttribution.md) |  | [optional] |
+| **source_credit** | **String** |  | [optional] |
+| **withheld_tiers** | **Array&lt;String&gt;** |  | [optional] |
+| **withheld_columns** | **Array&lt;String&gt;** |  | [optional] |
+| **freshness** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash&lt;String, Object&gt;** |  | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::LegalEntitiesResponse.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/LegalEntitiesRow.md ADDED Viewed

@@ -0,0 +1,56 @@
+# PharmaObservatory::LegalEntitiesRow
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_id** | **String** | The organization record id: a registered legal entity (edgar:, ror:) or a name-resolved sponsor (sponsor:). | [optional] |
+| **org_name** | **String** | The organization&#39;s name. | [optional] |
+| **is_name_resolved_sponsor** | **Boolean** | True for a sponsor resolved from a filed name alone rather than from a registration. | [optional] |
+| **org_origin** | **String** | How the organization record was minted. | [optional] |
+| **country** | **String** | Country as the source states it. | [optional] |
+| **org_type** | **String** | Organization type. | [optional] |
+| **edgar_cik** | **String** | Central index key (CIK) in EDGAR, the US Securities and Exchange Commission (SEC) filing system, when it files. | [optional] |
+| **edgar_ticker** | **String** | Exchange ticker, when listed. | [optional] |
+| **ror_id** | **String** | Research Organization Registry id, when it has one. | [optional] |
+| **lei** | **String** | Legal Entity Identifier, when it has one. | [optional] |
+| **lifecycle_status** | **String** | Lifecycle status from the registry sources. | [optional] |
+| **num_lead_trials** | **Integer** | Trials the organization leads. | [optional] |
+| **num_trials** | **Integer** | Trials the organization leads or collaborates on. | [optional] |
+| **total_lead_enrollment** | **Float** | Planned enrollment across led trials. | [optional] |
+| **num_recent_lead_trials** | **Integer** | Led trials started in the recent window. | [optional] |
+| **activity_score** | **Float** | Trial activity score. | [optional] |
+| **company_id** | **String** | Company level: the company the organization belongs to (null when unresolved). | [optional] |
+| **company_name** | **String** | Display name of the company. | [optional] |
+| **group_id** | **String** | Group level: the company&#39;s current ultimate parent; a root&#39;s group is itself. | [optional] |
+| **group_name** | **String** | Display name of the group. | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::LegalEntitiesRow.new(
+  org_id: null,
+  org_name: null,
+  is_name_resolved_sponsor: null,
+  org_origin: null,
+  country: null,
+  org_type: null,
+  edgar_cik: null,
+  edgar_ticker: null,
+  ror_id: null,
+  lei: null,
+  lifecycle_status: null,
+  num_lead_trials: null,
+  num_trials: null,
+  total_lead_enrollment: null,
+  num_recent_lead_trials: null,
+  activity_score: null,
+  company_id: null,
+  company_name: null,
+  group_id: null,
+  group_name: null
+)
+```

data/docs/OwnershipPositionsResponse.md ADDED Viewed

@@ -0,0 +1,58 @@
+# PharmaObservatory::OwnershipPositionsResponse
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset** | **String** |  |  |
+| **grain** | **String** |  | [optional] |
+| **object_type** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **scope** | [**BiomarkerCdxAssertionsResponseScope**](BiomarkerCdxAssertionsResponseScope.md) |  | [optional] |
+| **columns** | [**Array&lt;DatasetColumn&gt;**](DatasetColumn.md) |  |  |
+| **rows** | [**Array&lt;OwnershipPositionsRow&gt;**](OwnershipPositionsRow.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&lt;String&gt;** |  | [optional] |
+| **filters** | **Array&lt;Hash&lt;String, Object&gt;&gt;** |  | [optional] |
+| **group_by** | **Array&lt;String&gt;** |  | [optional] |
+| **measures** | **Array&lt;String&gt;** |  | [optional] |
+| **attribution** | [**Array&lt;DatasetAttribution&gt;**](DatasetAttribution.md) |  | [optional] |
+| **source_credit** | **String** |  | [optional] |
+| **withheld_tiers** | **Array&lt;String&gt;** |  | [optional] |
+| **withheld_columns** | **Array&lt;String&gt;** |  | [optional] |
+| **freshness** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash&lt;String, Object&gt;** |  | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::OwnershipPositionsResponse.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/OwnershipPositionsRow.md ADDED Viewed

@@ -0,0 +1,100 @@
+# PharmaObservatory::OwnershipPositionsRow
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **position_id** | **String** | The position id. For a position whose owner name is withheld it is an opaque handle that derives nothing from the owner and is stable only while the other positions of the same owned company, filing family and dimension are unchanged. | [optional] |
+| **source_class** | **String** | The filing family: sec_forms_3_4_5 (insiders), sec_schedules_13d_g (beneficial owners), sec_form_adv (investment adviser control persons) or sec_def_14a (proxy-statement tables). | [optional] |
+| **ownership_dimension** | **String** | What the position measures: insider_reporting, beneficial_ownership, voting_power, economic_interest or control. Positions of different dimensions are different measurements and are not added. | [optional] |
+| **relationship_type** | **String** | The owner&#39;s relationship to the company as the filing family states it. | [optional] |
+| **subject_name** | **String** | The owned company as filed. | [optional] |
+| **subject_org_id** | **String** | Legal-entity level: the owned company&#39;s organization record. | [optional] |
+| **subject_company_id** | **String** | Company level: the owned company (null when unresolved). | [optional] |
+| **subject_company_name** | **String** | Display name of the owned company. | [optional] |
+| **subject_group_id** | **String** | Group level: the owned company&#39;s current ultimate parent; a root&#39;s group is itself. | [optional] |
+| **subject_group_name** | **String** | Display name of the owned company&#39;s group. | [optional] |
+| **owner_name** | **String** | The owner&#39;s name as filed. Null for an owner whose filing does not mark the name public (see owner_name_is_public). | [optional] |
+| **owner_name_is_public** | **Boolean** | True when the filing marks the owner&#39;s name public. When false every column that could identify the owner is null (name, identity key, person id, investor id, organization and company columns, source_url and the dates); the position and its figures stay. | [optional] |
+| **owner_kind** | **String** | What the owner is: organization, natural_person, reporting_group or unknown. | [optional] |
+| **owner_identity_key** | **String** | The owner&#39;s stable identity (an SEC registration number or an adviser registration number); null when the name is withheld. | [optional] |
+| **owner_person_id** | **String** | The key of an owner who is a natural person; null for other owners and when the name is withheld. | [optional] |
+| **owner_investor_id** | **String** | The key of the owner in the investor directory when it is one; null when the name is withheld. | [optional] |
+| **owner_org_id** | **String** | Legal-entity level: the owner&#39;s organization record (null when the owner is not an organization, is unresolved or is withheld). | [optional] |
+| **owner_company_id** | **String** | Company level: the owner&#39;s company (null when unresolved or when the name is withheld). | [optional] |
+| **owner_company_name** | **String** | Display name of the owner&#39;s company. | [optional] |
+| **owner_group_id** | **String** | Group level: the owner&#39;s current ultimate parent; a root&#39;s group is itself (null when the owner is withheld). | [optional] |
+| **owner_group_name** | **String** | Display name of the owner&#39;s group. | [optional] |
+| **shares_basis** | **String** | How the share figure was reached: sum_standing_balances (insider balances), group_reported_maximum (a joint filing&#39;s maximum, never a sum of its filers) or no_quantity (the source gives none). Read a share figure with its basis. | [optional] |
+| **shares** | **Float** | Shares the owner holds, on the shares_basis. Null when the source gives no quantity. | [optional] |
+| **shares_direct** | **Float** | Of those shares, the part held directly. | [optional] |
+| **shares_indirect** | **Float** | Of those shares, the part held indirectly. | [optional] |
+| **derivative_underlying_shares** | **Float** | Shares underlying derivative positions such as options, reported apart and never added to shares. | [optional] |
+| **percent_basis** | **String** | How the percentage was reached, for example single_reporting_person, uniform_group_percent or single_band. | [optional] |
+| **reported_percent** | **Float** | The percentage the filing reports, on the percentage_basis. | [optional] |
+| **reported_percent_low** | **Float** | The low end of a reported band, for a source that reports a band. | [optional] |
+| **reported_percent_high** | **Float** | The high end of a reported band, for a source that reports a band. | [optional] |
+| **percentage_basis** | **String** | What the percentage is of: beneficial_ownership, voting_power or economic_interest. Percentages of different bases are not comparable. | [optional] |
+| **edge_state** | **String** | standing, ceased or no_longer_reported, for the owner&#39;s position as a whole. | [optional] |
+| **position_count** | **Integer** | Positions the row consolidates. | [optional] |
+| **standing_position_count** | **Integer** | Of those, positions still standing. | [optional] |
+| **ceased_position_count** | **Integer** | Of those, positions reported ceased. | [optional] |
+| **no_longer_reported_position_count** | **Integer** | Of those, positions the filer no longer reports. | [optional] |
+| **first_observed_date** | **Date** | Date the position was first reported; null when the owner&#39;s name is withheld. | [optional] |
+| **last_activity_date** | **Date** | Date of the latest reported activity; null when the owner&#39;s name is withheld. | [optional] |
+| **last_filing_date** | **Date** | Date of the latest filing; null when the owner&#39;s name is withheld. | [optional] |
+| **source_url** | **String** | A link to the latest filing; null when the owner&#39;s name is withheld, because the filing names the owner. | [optional] |
+| **contains_personal_data** | **Boolean** | True when the row names a natural person. | [optional] |
+| **privacy_status** | **String** | The filing&#39;s privacy status for the owner: not_applicable, pending_review, approved_public_fields, restricted or protected. | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::OwnershipPositionsRow.new(
+  position_id: null,
+  source_class: null,
+  ownership_dimension: null,
+  relationship_type: null,
+  subject_name: null,
+  subject_org_id: null,
+  subject_company_id: null,
+  subject_company_name: null,
+  subject_group_id: null,
+  subject_group_name: null,
+  owner_name: null,
+  owner_name_is_public: null,
+  owner_kind: null,
+  owner_identity_key: null,
+  owner_person_id: null,
+  owner_investor_id: null,
+  owner_org_id: null,
+  owner_company_id: null,
+  owner_company_name: null,
+  owner_group_id: null,
+  owner_group_name: null,
+  shares_basis: null,
+  shares: null,
+  shares_direct: null,
+  shares_indirect: null,
+  derivative_underlying_shares: null,
+  percent_basis: null,
+  reported_percent: null,
+  reported_percent_low: null,
+  reported_percent_high: null,
+  percentage_basis: null,
+  edge_state: null,
+  position_count: null,
+  standing_position_count: null,
+  ceased_position_count: null,
+  no_longer_reported_position_count: null,
+  first_observed_date: null,
+  last_activity_date: null,
+  last_filing_date: null,
+  source_url: null,
+  contains_personal_data: null,
+  privacy_status: null
+)
+```

data/docs/PdufaDatesResponse.md ADDED Viewed

@@ -0,0 +1,58 @@
+# PharmaObservatory::PdufaDatesResponse
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset** | **String** |  |  |
+| **grain** | **String** |  | [optional] |
+| **object_type** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **scope** | [**BiomarkerCdxAssertionsResponseScope**](BiomarkerCdxAssertionsResponseScope.md) |  | [optional] |
+| **columns** | [**Array&lt;DatasetColumn&gt;**](DatasetColumn.md) |  |  |
+| **rows** | [**Array&lt;PdufaDatesRow&gt;**](PdufaDatesRow.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&lt;String&gt;** |  | [optional] |
+| **filters** | **Array&lt;Hash&lt;String, Object&gt;&gt;** |  | [optional] |
+| **group_by** | **Array&lt;String&gt;** |  | [optional] |
+| **measures** | **Array&lt;String&gt;** |  | [optional] |
+| **attribution** | [**Array&lt;DatasetAttribution&gt;**](DatasetAttribution.md) |  | [optional] |
+| **source_credit** | **String** |  | [optional] |
+| **withheld_tiers** | **Array&lt;String&gt;** |  | [optional] |
+| **withheld_columns** | **Array&lt;String&gt;** |  | [optional] |
+| **freshness** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash&lt;String, Object&gt;** |  | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::PdufaDatesResponse.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/PdufaDatesRow.md ADDED Viewed

@@ -0,0 +1,66 @@
+# PharmaObservatory::PdufaDatesRow
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pdufa_date_id** | **String** | The calendar entry id. | [optional] |
+| **source** | **String** | Which lane the row came from: benzinga, sec_extraction or both. | [optional] |
+| **restriction_tier** | **String** | none for a row from SEC filings; licensable for a row from the Benzinga calendar (the filings are those made to the US Securities and Exchange Commission). | [optional] |
+| **decision_date** | **Date** | The decision date of the US Food and Drug Administration (FDA); a PDUFA date is the goal date under the Prescription Drug User Fee Act. | [optional] |
+| **date_start** | **Date** | Start of the date interval the source states. | [optional] |
+| **date_end** | **Date** | End of the date interval the source states. | [optional] |
+| **date_precision** | **String** | Precision of the date (day, month, quarter). | [optional] |
+| **date_phrase** | **String** | The date as the source words it. | [optional] |
+| **event_type** | **String** | Event type. | [optional] |
+| **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] |
+| **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] |
+| **sponsor_company_name** | **String** | Display name of the sponsor&#39;s company. | [optional] |
+| **sponsor_group_id** | **String** | Group level: the sponsor&#39;s current ultimate parent company; a root company&#39;s group is itself. | [optional] |
+| **sponsor_group_name** | **String** | Display name of the sponsor&#39;s group. | [optional] |
+| **ticker** | **String** | Exchange ticker. | [optional] |
+| **condition_id** | **String** | The condition key. | [optional] |
+| **condition_name** | **String** | The condition&#39;s name. | [optional] |
+| **indication_text** | **String** | The indication as the source words it. | [optional] |
+| **source_type** | **String** | Kind of source document. | [optional] |
+| **source_link** | **String** | Link to the source document. | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::PdufaDatesRow.new(
+  pdufa_date_id: null,
+  source: null,
+  restriction_tier: null,
+  decision_date: null,
+  date_start: null,
+  date_end: null,
+  date_precision: null,
+  date_phrase: null,
+  event_type: null,
+  event_category: null,
+  drug_name: null,
+  drug_id: null,
+  molecule_id: 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,
+  condition_id: null,
+  condition_name: null,
+  indication_text: null,
+  source_type: null,
+  source_link: null
+)
+```

data/docs/QueryApi.md ADDED Viewed

@@ -0,0 +1,149 @@
+# PharmaObservatory::QueryApi
+All URIs are relative to *https://pharmaobservatory.com*
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**query_result**](QueryApi.md#query_result) | **GET** /api/v1/results/{result_id} | Page a stored result |
+| [**query_run**](QueryApi.md#query_run) | **POST** /api/v1/query | Run a SQL query |
+## query_result
+> <ResultPage> query_result(result_id, opts)
+Page a stored result
+### 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::QueryApi.new
+result_id = '5d3f6a1e-0c1b-4f7e-9a52-2b8c1d4e6f70' # String |
+opts = {
+  cursor: 'eyJvIjoyMDB9' # String |
+}
+begin
+  # Page a stored result
+  result = api_instance.query_result(result_id, opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling QueryApi->query_result: #{e}"
+end
+```
+#### Using the query_result_with_http_info variant
+This returns an Array which contains the response data, status code and headers.
+> <Array(<ResultPage>, Integer, Hash)> query_result_with_http_info(result_id, opts)
+```ruby
+begin
+  # Page a stored result
+  data, status_code, headers = api_instance.query_result_with_http_info(result_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ResultPage>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling QueryApi->query_result_with_http_info: #{e}"
+end
+```
+### Parameters
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **result_id** | **String** |  |  |
+| **cursor** | **String** |  | [optional] |
+### Return type
+[**ResultPage**](ResultPage.md)
+### Authorization
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+### HTTP request headers
+- **Content-Type**: Not defined
+- **Accept**: application/json
+## query_run
+> <QueryResponse> query_run(opts)
+Run a SQL query
+### 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::QueryApi.new
+opts = {
+  query_run_request: PharmaObservatory::QueryRunRequest.new({sql: 'sql_example'}) # QueryRunRequest |
+}
+begin
+  # Run a SQL query
+  result = api_instance.query_run(opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling QueryApi->query_run: #{e}"
+end
+```
+#### Using the query_run_with_http_info variant
+This returns an Array which contains the response data, status code and headers.
+> <Array(<QueryResponse>, Integer, Hash)> query_run_with_http_info(opts)
+```ruby
+begin
+  # Run a SQL query
+  data, status_code, headers = api_instance.query_run_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <QueryResponse>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling QueryApi->query_run_with_http_info: #{e}"
+end
+```
+### Parameters
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **query_run_request** | [**QueryRunRequest**](QueryRunRequest.md) |  | [optional] |
+### Return type
+[**QueryResponse**](QueryResponse.md)
+### Authorization
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+### HTTP request headers
+- **Content-Type**: application/json
+- **Accept**: application/json

data/docs/QueryError.md ADDED Viewed

@@ -0,0 +1,24 @@
+# PharmaObservatory::QueryError
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error_code** | **String** |  |  |
+| **message** | **String** |  |  |
+| **hint** | **String** |  | [optional] |
+| **docs** | **String** |  | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::QueryError.new(
+  error_code: null,
+  message: null,
+  hint: null,
+  docs: null
+)
+```

data/docs/QueryResponse.md ADDED Viewed

@@ -0,0 +1,42 @@
+# PharmaObservatory::QueryResponse
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **columns** | [**Array&lt;QueryResponseColumnsInner&gt;**](QueryResponseColumnsInner.md) |  |  |
+| **rows** | **Array&lt;Array&lt;Object&gt;&gt;** |  |  |
+| **total_rows** | **Integer** |  | [optional] |
+| **truncated** | **Boolean** |  | [optional] |
+| **result_id** | **String** |  |  |
+| **next_cursor** | **String** |  | [optional] |
+| **attribution** | [**Array&lt;DatasetAttribution&gt;**](DatasetAttribution.md) |  | [optional] |
+| **source_credit** | **String** |  | [optional] |
+| **withheld_tiers** | **Array&lt;String&gt;** |  | [optional] |
+| **withheld_columns** | **Array&lt;String&gt;** |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **dataset** | **String** |  |  |
+| **notice** | **String** |  | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::QueryResponse.new(
+  columns: null,
+  rows: null,
+  total_rows: null,
+  truncated: null,
+  result_id: null,
+  next_cursor: null,
+  attribution: null,
+  source_credit: null,
+  withheld_tiers: null,
+  withheld_columns: null,
+  build_state: null,
+  dataset: null,
+  notice: null
+)
+```