pharmaobservatory 0.1.0

data/docs/ApiV1ProgramCatalystApi.md

@@ -0,0 +1,291 @@
+# PharmaObservatory::ApiV1ProgramCatalystApi
+
+All URIs are relative to *https://pharmaobservatory.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_v1_licensing_candidates_get**](ApiV1ProgramCatalystApi.md#api_v1_licensing_candidates_get) | **GET** /api/v1/licensing_candidates | licensing_candidates |
+| [**api_v1_org_pipeline_stages_get**](ApiV1ProgramCatalystApi.md#api_v1_org_pipeline_stages_get) | **GET** /api/v1/org_pipeline_stages | pipeline_stages |
+| [**api_v1_patent_cliff_exposure_get**](ApiV1ProgramCatalystApi.md#api_v1_patent_cliff_exposure_get) | **GET** /api/v1/patent_cliff_exposure | patent_cliff_exposure |
+| [**api_v1_program_catalysts_get**](ApiV1ProgramCatalystApi.md#api_v1_program_catalysts_get) | **GET** /api/v1/program_catalysts | catalysts |
+
+
+## api_v1_licensing_candidates_get
+
+> <ApiV1LicensingCandidatesGet200Response> api_v1_licensing_candidates_get(opts)
+
+licensing_candidates
+
+### 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::ApiV1ProgramCatalystApi.new
+opts = {
+  condition_id: 'D003920' # String | 
+}
+
+begin
+  # licensing_candidates
+  result = api_instance.api_v1_licensing_candidates_get(opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ApiV1ProgramCatalystApi->api_v1_licensing_candidates_get: #{e}"
+end
+```
+
+#### Using the api_v1_licensing_candidates_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV1LicensingCandidatesGet200Response>, Integer, Hash)> api_v1_licensing_candidates_get_with_http_info(opts)
+
+```ruby
+begin
+  # licensing_candidates
+  data, status_code, headers = api_instance.api_v1_licensing_candidates_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV1LicensingCandidatesGet200Response>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ApiV1ProgramCatalystApi->api_v1_licensing_candidates_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **condition_id** | **String** |  | [optional] |
+
+### Return type
+
+[**ApiV1LicensingCandidatesGet200Response**](ApiV1LicensingCandidatesGet200Response.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## api_v1_org_pipeline_stages_get
+
+> <ApiV1OrgPipelineStagesGet200Response> api_v1_org_pipeline_stages_get(opts)
+
+pipeline_stages
+
+### 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::ApiV1ProgramCatalystApi.new
+opts = {
+  company_id: 'edgar:0001048477' # String | 
+}
+
+begin
+  # pipeline_stages
+  result = api_instance.api_v1_org_pipeline_stages_get(opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ApiV1ProgramCatalystApi->api_v1_org_pipeline_stages_get: #{e}"
+end
+```
+
+#### Using the api_v1_org_pipeline_stages_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV1OrgPipelineStagesGet200Response>, Integer, Hash)> api_v1_org_pipeline_stages_get_with_http_info(opts)
+
+```ruby
+begin
+  # pipeline_stages
+  data, status_code, headers = api_instance.api_v1_org_pipeline_stages_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV1OrgPipelineStagesGet200Response>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ApiV1ProgramCatalystApi->api_v1_org_pipeline_stages_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  | [optional] |
+
+### Return type
+
+[**ApiV1OrgPipelineStagesGet200Response**](ApiV1OrgPipelineStagesGet200Response.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## api_v1_patent_cliff_exposure_get
+
+> <ApiV1PatentCliffExposureGet200Response> api_v1_patent_cliff_exposure_get(opts)
+
+patent_cliff_exposure
+
+### 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::ApiV1ProgramCatalystApi.new
+opts = {
+  company_ids: ['inner_example'], # Array<String> | 
+  drug_ids: ['inner_example'] # Array<String> | 
+}
+
+begin
+  # patent_cliff_exposure
+  result = api_instance.api_v1_patent_cliff_exposure_get(opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ApiV1ProgramCatalystApi->api_v1_patent_cliff_exposure_get: #{e}"
+end
+```
+
+#### Using the api_v1_patent_cliff_exposure_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV1PatentCliffExposureGet200Response>, Integer, Hash)> api_v1_patent_cliff_exposure_get_with_http_info(opts)
+
+```ruby
+begin
+  # patent_cliff_exposure
+  data, status_code, headers = api_instance.api_v1_patent_cliff_exposure_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV1PatentCliffExposureGet200Response>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ApiV1ProgramCatalystApi->api_v1_patent_cliff_exposure_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_ids** | [**Array&lt;String&gt;**](String.md) |  | [optional] |
+| **drug_ids** | [**Array&lt;String&gt;**](String.md) |  | [optional] |
+
+### Return type
+
+[**ApiV1PatentCliffExposureGet200Response**](ApiV1PatentCliffExposureGet200Response.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## api_v1_program_catalysts_get
+
+> <ApiV1ProgramCatalystsGet200Response> api_v1_program_catalysts_get(opts)
+
+catalysts
+
+### 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::ApiV1ProgramCatalystApi.new
+opts = {
+  company_ids: ['inner_example'], # Array<String> | 
+  drug_ids: ['inner_example'] # Array<String> | 
+}
+
+begin
+  # catalysts
+  result = api_instance.api_v1_program_catalysts_get(opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ApiV1ProgramCatalystApi->api_v1_program_catalysts_get: #{e}"
+end
+```
+
+#### Using the api_v1_program_catalysts_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV1ProgramCatalystsGet200Response>, Integer, Hash)> api_v1_program_catalysts_get_with_http_info(opts)
+
+```ruby
+begin
+  # catalysts
+  data, status_code, headers = api_instance.api_v1_program_catalysts_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV1ProgramCatalystsGet200Response>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ApiV1ProgramCatalystApi->api_v1_program_catalysts_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_ids** | [**Array&lt;String&gt;**](String.md) |  | [optional] |
+| **drug_ids** | [**Array&lt;String&gt;**](String.md) |  | [optional] |
+
+### Return type
+
+[**ApiV1ProgramCatalystsGet200Response**](ApiV1ProgramCatalystsGet200Response.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ApiV1ProgramCatalystsGet200Response.md

@@ -0,0 +1,32 @@
+# PharmaObservatory::ApiV1ProgramCatalystsGet200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **drug_ids** | **Array<String>** |  |  |
+| **company_ids** | **Array<String>** |  |  |
+| **calendar** | [**Array<ApiV1ProgramCatalystsGet200ResponseCalendarInner>**](ApiV1ProgramCatalystsGet200ResponseCalendarInner.md) |  |  |
+| **pdufa** | [**ApiV1ProgramCatalystsGet200ResponsePdufa**](ApiV1ProgramCatalystsGet200ResponsePdufa.md) |  |  |
+| **build_state** | [**ApiV1ConditionsConditionIdEvidenceFreshnessGet200ResponseBuildState**](ApiV1ConditionsConditionIdEvidenceFreshnessGet200ResponseBuildState.md) |  |  |
+| **sections** | [**ApiV1ProgramCatalystsGet200ResponseSections**](ApiV1ProgramCatalystsGet200ResponseSections.md) |  |  |
+| **error** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ApiV1ProgramCatalystsGet200Response.new(
+  drug_ids: null,
+  company_ids: null,
+  calendar: null,
+  pdufa: null,
+  build_state: null,
+  sections: null,
+  error: null,
+  message: null
+)
+```
+

data/docs/ApiV1ProgramCatalystsGet200ResponseCalendarInner.md

@@ -0,0 +1,46 @@
+# PharmaObservatory::ApiV1ProgramCatalystsGet200ResponseCalendarInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_type** | **String** |  |  |
+| **id** | **String** |  |  |
+| **date** | **String** |  |  |
+| **nct_id** | **String** |  | [optional] |
+| **title** | **String** |  |  |
+| **phase** | **String** |  | [optional] |
+| **matched_drug_ids** | **Array<Object>** |  | [optional] |
+| **matched_company_ids** | **Array<String>** |  | [optional] |
+| **canonical_drug_id** | **String** |  | [optional] |
+| **canonical_org_id** | **String** |  | [optional] |
+| **drug_name** | **String** |  | [optional] |
+| **cliff_year** | **Integer** |  | [optional] |
+| **cliff_basis** | **String** |  | [optional] |
+| **org_name** | **String** |  | [optional] |
+| **source** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ApiV1ProgramCatalystsGet200ResponseCalendarInner.new(
+  event_type: null,
+  id: null,
+  date: null,
+  nct_id: null,
+  title: null,
+  phase: null,
+  matched_drug_ids: null,
+  matched_company_ids: null,
+  canonical_drug_id: null,
+  canonical_org_id: null,
+  drug_name: null,
+  cliff_year: null,
+  cliff_basis: null,
+  org_name: null,
+  source: null
+)
+```
+

data/docs/ApiV1ProgramCatalystsGet200ResponsePdufa.md

@@ -0,0 +1,26 @@
+# PharmaObservatory::ApiV1ProgramCatalystsGet200ResponsePdufa
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tier** | **String** |  |  |
+| **license** | **String** |  |  |
+| **attribution** | **String** |  |  |
+| **visible** | **Boolean** |  |  |
+| **reason** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ApiV1ProgramCatalystsGet200ResponsePdufa.new(
+  tier: null,
+  license: null,
+  attribution: null,
+  visible: null,
+  reason: null
+)
+```
+

data/docs/ApiV1ProgramCatalystsGet200ResponseSections.md

@@ -0,0 +1,22 @@
+# PharmaObservatory::ApiV1ProgramCatalystsGet200ResponseSections
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **trial_readouts** | [**ApiV1BiomarkerAssayScreenGet200ResponseBuildState**](ApiV1BiomarkerAssayScreenGet200ResponseBuildState.md) |  |  |
+| **exclusivity_lapses** | [**ApiV1BiomarkerAssayScreenGet200ResponseBuildState**](ApiV1BiomarkerAssayScreenGet200ResponseBuildState.md) |  |  |
+| **pdufa** | [**ApiV1BiomarkerAssayScreenGet200ResponseBuildState**](ApiV1BiomarkerAssayScreenGet200ResponseBuildState.md) |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ApiV1ProgramCatalystsGet200ResponseSections.new(
+  trial_readouts: null,
+  exclusivity_lapses: null,
+  pdufa: null
+)
+```
+

data/docs/ApiV1ResolveEntityApi.md

@@ -0,0 +1,83 @@
+# PharmaObservatory::ApiV1ResolveEntityApi
+
+All URIs are relative to *https://pharmaobservatory.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_v1_resolve_entity_get**](ApiV1ResolveEntityApi.md#api_v1_resolve_entity_get) | **GET** /api/v1/resolve_entity | Resolve a free-text or coded entity mention to a canonical Pharma Observatory ID |
+
+
+## api_v1_resolve_entity_get
+
+> <ApiV1ResolveEntityGet200Response> api_v1_resolve_entity_get(opts)
+
+Resolve a free-text or coded entity mention to a canonical Pharma Observatory ID
+
+### 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::ApiV1ResolveEntityApi.new
+opts = {
+  query: 'Anchorloss Biotherapeutics', # String | 
+  raw_key: 'biomarin', # String | 
+  source_type: 'aact_sponsor', # String | 
+  spine: 'institution' # String | 
+}
+
+begin
+  # Resolve a free-text or coded entity mention to a canonical Pharma Observatory ID
+  result = api_instance.api_v1_resolve_entity_get(opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ApiV1ResolveEntityApi->api_v1_resolve_entity_get: #{e}"
+end
+```
+
+#### Using the api_v1_resolve_entity_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV1ResolveEntityGet200Response>, Integer, Hash)> api_v1_resolve_entity_get_with_http_info(opts)
+
+```ruby
+begin
+  # Resolve a free-text or coded entity mention to a canonical Pharma Observatory ID
+  data, status_code, headers = api_instance.api_v1_resolve_entity_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV1ResolveEntityGet200Response>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ApiV1ResolveEntityApi->api_v1_resolve_entity_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **query** | **String** |  | [optional] |
+| **raw_key** | **String** |  | [optional] |
+| **source_type** | **String** |  | [optional] |
+| **spine** | **String** |  | [optional] |
+
+### Return type
+
+[**ApiV1ResolveEntityGet200Response**](ApiV1ResolveEntityGet200Response.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ApiV1ResolveEntityGet200Response.md

@@ -0,0 +1,36 @@
+# PharmaObservatory::ApiV1ResolveEntityGet200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **spine** | **String** |  |  |
+| **mode** | **String** |  |  |
+| **query** | **String** |  |  |
+| **source_type** | **String** |  |  |
+| **raw_key** | **String** |  |  |
+| **candidates** | [**Array<ApiV1ResolveEntityGet200ResponseCandidatesInner>**](ApiV1ResolveEntityGet200ResponseCandidatesInner.md) |  |  |
+| **persistence_stable** | **Boolean** |  |  |
+| **message** | **String** |  | [optional] |
+| **resolution_confidence** | [**ApiV1ResolveEntityGet200ResponseResolutionConfidence**](ApiV1ResolveEntityGet200ResponseResolutionConfidence.md) |  |  |
+| **build_state** | [**ApiV1BiomarkerAssayScreenGet200ResponseBuildState**](ApiV1BiomarkerAssayScreenGet200ResponseBuildState.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ApiV1ResolveEntityGet200Response.new(
+  spine: null,
+  mode: null,
+  query: null,
+  source_type: null,
+  raw_key: null,
+  candidates: null,
+  persistence_stable: null,
+  message: null,
+  resolution_confidence: null,
+  build_state: null
+)
+```
+

data/docs/ApiV1ResolveEntityGet200ResponseCandidatesInner.md

@@ -0,0 +1,26 @@
+# PharmaObservatory::ApiV1ResolveEntityGet200ResponseCandidatesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **display_name** | **String** |  |  |
+| **subtitle** | **String** |  |  |
+| **restriction** | [**ApiV1ResolveEntityGet200ResponseCandidatesInnerRestriction**](ApiV1ResolveEntityGet200ResponseCandidatesInnerRestriction.md) |  |  |
+| **name_withheld_note** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ApiV1ResolveEntityGet200ResponseCandidatesInner.new(
+  id: null,
+  display_name: null,
+  subtitle: null,
+  restriction: null,
+  name_withheld_note: null
+)
+```
+

data/docs/ApiV1ResolveEntityGet200ResponseCandidatesInnerRestriction.md

@@ -0,0 +1,22 @@
+# PharmaObservatory::ApiV1ResolveEntityGet200ResponseCandidatesInnerRestriction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tier** | **String** |  |  |
+| **license** | **String** |  |  |
+| **attribution** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ApiV1ResolveEntityGet200ResponseCandidatesInnerRestriction.new(
+  tier: null,
+  license: null,
+  attribution: null
+)
+```
+

data/docs/ApiV1ResolveEntityGet200ResponseResolutionConfidence.md

@@ -0,0 +1,20 @@
+# PharmaObservatory::ApiV1ResolveEntityGet200ResponseResolutionConfidence
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **match_tier** | **String** |  |  |
+| **verdict** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ApiV1ResolveEntityGet200ResponseResolutionConfidence.new(
+  match_tier: null,
+  verdict: null
+)
+```
+