pharmaobservatory 0.1.2 → 0.1.4

data/docs/ConditionsRecord.md

@@ -0,0 +1,38 @@
+# PharmaObservatory::ConditionsRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object_type** | **String** |  |  |
+| **id** | **String** |  |  |
+| **record** | [**ConditionsRow**](ConditionsRow.md) |  |  |
+| **attributes** | [**ConditionsRecordAttributes**](ConditionsRecordAttributes.md) |  | [optional] |
+| **datasets** | [**Array<DatasetListing>**](DatasetListing.md) |  |  |
+| **attribution** | [**Array<DatasetAttribution>**](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<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ConditionsRecord.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/ConditionsRecordAttributes.md

@@ -0,0 +1,20 @@
+# PharmaObservatory::ConditionsRecordAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **condition_burden** | [**ConditionBurdenRow**](ConditionBurdenRow.md) |  | [optional] |
+| **condition_delivery** | [**ConditionDeliveryRow**](ConditionDeliveryRow.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ConditionsRecordAttributes.new(
+  condition_burden: null,
+  condition_delivery: null
+)
+```
+

data/docs/ConditionsResponse.md

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

@@ -0,0 +1,32 @@
+# PharmaObservatory::ConditionsRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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 MeSH heading. | [optional] |
+| **primary_category** | **String** | The condition's primary MeSH disease category. | [optional] |
+| **categories** | **Array<String>** | The MeSH tree branches the condition sits under (C and F03 codes). | [optional] |
+| **is_neoplasm** | **Boolean** | True when the condition sits under the MeSH neoplasms branch (C04). | [optional] |
+| **tree_numbers** | **Array<String>** | The condition's MeSH tree numbers. | [optional] |
+| **n_trials** | **Integer** | Trials tagged with the condition or with a condition beneath it in the MeSH tree. | [optional] |
+| **n_direct_trials** | **Integer** | Trials tagged with the condition itself. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ConditionsRow.new(
+  condition_id: null,
+  condition_name: null,
+  primary_category: null,
+  categories: null,
+  is_neoplasm: null,
+  tree_numbers: null,
+  n_trials: null,
+  n_direct_trials: null
+)
+```
+

data/docs/DatasetAttribution.md

@@ -0,0 +1,26 @@
+# PharmaObservatory::DatasetAttribution
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **license** | **String** |  | [optional] |
+| **href** | **String** |  | [optional] |
+| **license_href** | **String** |  | [optional] |
+| **note** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::DatasetAttribution.new(
+  name: null,
+  license: null,
+  href: null,
+  license_href: null,
+  note: null
+)
+```
+

data/docs/DatasetBuildState.md

@@ -0,0 +1,22 @@
+# PharmaObservatory::DatasetBuildState
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **built** | **Boolean** |  | [optional] |
+| **generation** | **String** |  | [optional] |
+| **last_loaded** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::DatasetBuildState.new(
+  built: null,
+  generation: null,
+  last_loaded: null
+)
+```
+

data/docs/DatasetColumn.md

@@ -0,0 +1,30 @@
+# PharmaObservatory::DatasetColumn
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **unit** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **entity** | **String** |  | [optional] |
+| **level** | **String** |  | [optional] |
+| **tier** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::DatasetColumn.new(
+  name: null,
+  type: null,
+  unit: null,
+  description: null,
+  entity: null,
+  level: null,
+  tier: null
+)
+```
+

data/docs/DatasetListing.md

@@ -0,0 +1,32 @@
+# PharmaObservatory::DatasetListing
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **title** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **grain** | **String** |  | [optional] |
+| **tier** | **String** |  | [optional] |
+| **entitled** | **Boolean** |  | [optional] |
+| **row_count** | **Integer** |  | [optional] |
+| **href** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::DatasetListing.new(
+  name: null,
+  title: null,
+  description: null,
+  grain: null,
+  tier: null,
+  entitled: null,
+  row_count: null,
+  href: null
+)
+```
+

data/docs/DatasetSummaryList.md

@@ -0,0 +1,18 @@
+# PharmaObservatory::DatasetSummaryList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **datasets** | [**Array<DatasetSummaryListDatasetsInner>**](DatasetSummaryListDatasetsInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::DatasetSummaryList.new(
+  datasets: null
+)
+```
+

data/docs/DatasetSummaryListDatasetsInner.md

@@ -0,0 +1,32 @@
+# PharmaObservatory::DatasetSummaryListDatasetsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **title** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **grain** | **String** |  | [optional] |
+| **tier** | **String** |  | [optional] |
+| **object_types** | **Array<String>** |  | [optional] |
+| **column_count** | **Integer** |  | [optional] |
+| **source_credit** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::DatasetSummaryListDatasetsInner.new(
+  name: null,
+  title: null,
+  description: null,
+  grain: null,
+  tier: null,
+  object_types: null,
+  column_count: null,
+  source_credit: null
+)
+```
+

data/docs/DatasetsApi.md

@@ -0,0 +1,140 @@
+# PharmaObservatory::DatasetsApi
+
+All URIs are relative to *https://pharmaobservatory.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**datasets_get**](DatasetsApi.md#datasets_get) | **GET** /api/v1/datasets/{name} | Describe a dataset |
+| [**datasets_list**](DatasetsApi.md#datasets_list) | **GET** /api/v1/datasets | List the datasets |
+
+
+## datasets_get
+
+> Hash<String, Object> datasets_get(name)
+
+Describe a dataset
+
+### 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::DatasetsApi.new
+name = 'sponsor_trials' # String | 
+
+begin
+  # Describe a dataset
+  result = api_instance.datasets_get(name)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling DatasetsApi->datasets_get: #{e}"
+end
+```
+
+#### Using the datasets_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> datasets_get_with_http_info(name)
+
+```ruby
+begin
+  # Describe a dataset
+  data, status_code, headers = api_instance.datasets_get_with_http_info(name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Hash&lt;String, Object&gt;
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling DatasetsApi->datasets_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+
+### Return type
+
+**Hash&lt;String, Object&gt;**
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## datasets_list
+
+> <DatasetSummaryList> datasets_list
+
+List the datasets
+
+### 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::DatasetsApi.new
+
+begin
+  # List the datasets
+  result = api_instance.datasets_list
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling DatasetsApi->datasets_list: #{e}"
+end
+```
+
+#### Using the datasets_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DatasetSummaryList>, Integer, Hash)> datasets_list_with_http_info
+
+```ruby
+begin
+  # List the datasets
+  data, status_code, headers = api_instance.datasets_list_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DatasetSummaryList>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling DatasetsApi->datasets_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**DatasetSummaryList**](DatasetSummaryList.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/DrugPatentCliffResponse.md

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

@@ -0,0 +1,68 @@
+# PharmaObservatory::DrugPatentCliffRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **drug_id** | **String** | The drug key. | [optional] |
+| **drug_name** | **String** | The drug's name. | [optional] |
+| **pharm_class** | **String** | The drug's pharmacologic class. | [optional] |
+| **atc_class** | **String** | The drug's Anatomical Therapeutic Chemical (ATC) class. | [optional] |
+| **brand** | **String** | The brand name. | [optional] |
+| **candidate_brands** | **String** | Other candidate brand names, comma separated. | [optional] |
+| **cliff_date** | **Date** | The date exclusivity is expected to end (loss of exclusivity); always in the future when the dataset is built. | [optional] |
+| **cliff_year** | **Integer** | The year of cliff_date. | [optional] |
+| **cliff_basis** | **String** | Which regime set the date: curated_loe, orange_book_patent, pte_expiry or bpcia_exclusivity. | [optional] |
+| **cliff_source** | **String** | Source of a curated date (null on the other bases). | [optional] |
+| **cliff_confidence** | **String** | Confidence of a curated date (null on the other bases). | [optional] |
+| **has_generic** | **Boolean** | True when a generic is already marketed. | [optional] |
+| **biosimilar_available** | **Boolean** | True when a biosimilar is already marketed. | [optional] |
+| **applicant_name** | **String** | The brand or originator applicant as the Orange Book or Purple Book names it. | [optional] |
+| **applicant_org_id** | **String** | Legal-entity level: the organization record the applicant resolved to (null when unresolved). | [optional] |
+| **applicant_company_id** | **String** | Company level: the company the applicant belongs to (null when unresolved). | [optional] |
+| **applicant_company_name** | **String** | Display name of the applicant's company. | [optional] |
+| **applicant_group_id** | **String** | Group level: the applicant's current ultimate parent company; a root company's group is itself. | [optional] |
+| **applicant_group_name** | **String** | Display name of the applicant's group. | [optional] |
+| **applicant_match_scope** | **String** | How the applicant name matched an organization record. | [optional] |
+| **medicare_spend** | **Float** | Latest-year Medicare Part B and D spend for the drug, in US dollars. | [optional] |
+| **medicare_spend_year** | **Integer** | The year of medicare_spend. | [optional] |
+| **disclosed_revenue_usd_millions** | **Float** | Latest full-year disclosed worldwide revenue, in US millions. | [optional] |
+| **disclosed_revenue_year** | **Integer** | The fiscal year of the disclosed revenue. | [optional] |
+| **size_usd** | **Float** | The single size axis in US dollars: disclosed revenue when present, else Medicare spend. | [optional] |
+| **size_basis** | **String** | Which source size_usd used: disclosed_worldwide_revenue, medicare_spend or none. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::DrugPatentCliffRow.new(
+  drug_id: null,
+  drug_name: null,
+  pharm_class: null,
+  atc_class: null,
+  brand: null,
+  candidate_brands: null,
+  cliff_date: null,
+  cliff_year: null,
+  cliff_basis: null,
+  cliff_source: null,
+  cliff_confidence: null,
+  has_generic: null,
+  biosimilar_available: null,
+  applicant_name: null,
+  applicant_org_id: null,
+  applicant_company_id: null,
+  applicant_company_name: null,
+  applicant_group_id: null,
+  applicant_group_name: null,
+  applicant_match_scope: null,
+  medicare_spend: null,
+  medicare_spend_year: null,
+  disclosed_revenue_usd_millions: null,
+  disclosed_revenue_year: null,
+  size_usd: null,
+  size_basis: null
+)
+```
+

data/docs/InstitutionalHoldingsResponse.md

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