pharmaobservatory 0.1.2 → 0.1.3

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 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
+)
+```
+

data/docs/InstitutionalHoldingsRow.md

@@ -0,0 +1,64 @@
+# PharmaObservatory::InstitutionalHoldingsRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **holding_id** | **String** | The holding line id. | [optional] |
+| **issuer_name** | **String** | The security issuer as filed. | [optional] |
+| **issuer_org_id** | **String** | Legal-entity level: the issuer's organization record (null when unresolved). | [optional] |
+| **issuer_company_id** | **String** | Company level: the issuer's company (null when unresolved). | [optional] |
+| **issuer_company_name** | **String** | Display name of the issuer's company. | [optional] |
+| **issuer_group_id** | **String** | Group level: the issuer's current ultimate parent; a root's group is itself. | [optional] |
+| **issuer_group_name** | **String** | Display name of the issuer's group. | [optional] |
+| **security_ref** | **String** | The security's CUSIP reference. | [optional] |
+| **holder_name** | **String** | The institutional manager's name. | [optional] |
+| **holder_kind** | **String** | Manager kind. | [optional] |
+| **holder_org_id** | **String** | Legal-entity level: the manager's organization record (null when unresolved). | [optional] |
+| **holder_company_id** | **String** | Company level: the manager's company (null when unresolved). | [optional] |
+| **holder_company_name** | **String** | Display name of the manager's company. | [optional] |
+| **holder_group_id** | **String** | Group level: the manager's current ultimate parent. | [optional] |
+| **holder_group_name** | **String** | Display name of the manager's group. | [optional] |
+| **reported_value_amount** | **Float** | Reported value of the position. | [optional] |
+| **reported_value_currency** | **String** | Currency of the reported value. | [optional] |
+| **shares** | **Float** | Shares standing. | [optional] |
+| **percent_basis** | **String** | The basis the percent is measured on. | [optional] |
+| **reported_percent** | **Float** | Reported share of the issuer. | [optional] |
+| **edge_state** | **String** | State of the position (standing, ceased, no longer reported). | [optional] |
+| **first_observed_date** | **Date** | First filing date the position was observed. | [optional] |
+| **last_filing_date** | **Date** | Latest filing date the position was reported. | [optional] |
+| **contains_personal_data** | **Boolean** | Whether the holder is a natural person. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::InstitutionalHoldingsRow.new(
+  holding_id: null,
+  issuer_name: null,
+  issuer_org_id: null,
+  issuer_company_id: null,
+  issuer_company_name: null,
+  issuer_group_id: null,
+  issuer_group_name: null,
+  security_ref: null,
+  holder_name: null,
+  holder_kind: null,
+  holder_org_id: null,
+  holder_company_id: null,
+  holder_company_name: null,
+  holder_group_id: null,
+  holder_group_name: null,
+  reported_value_amount: null,
+  reported_value_currency: null,
+  shares: null,
+  percent_basis: null,
+  reported_percent: null,
+  edge_state: null,
+  first_observed_date: null,
+  last_filing_date: null,
+  contains_personal_data: null
+)
+```
+