pharmaobservatory 0.1.0

data/docs/ApiV1BiomarkerAssayWhitespaceApi.md

@@ -0,0 +1,87 @@
+# PharmaObservatory::ApiV1BiomarkerAssayWhitespaceApi
+
+All URIs are relative to *https://pharmaobservatory.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_v1_biomarker_assay_whitespace_get**](ApiV1BiomarkerAssayWhitespaceApi.md#api_v1_biomarker_assay_whitespace_get) | **GET** /api/v1/biomarker_assay_whitespace | index |
+
+
+## api_v1_biomarker_assay_whitespace_get
+
+> <ApiV1BiomarkerAssayWhitespaceGet200Response> api_v1_biomarker_assay_whitespace_get(opts)
+
+index
+
+### 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::ApiV1BiomarkerAssayWhitespaceApi.new
+opts = {
+  bucket: 'served', # String | 
+  gene: 'A1BG', # String | 
+  gene_evidence_tier: 'literature_only', # String | 
+  gene_supply_status: 'declared_positive', # String | 
+  limit: 700, # Integer | 
+  q: 'EGFR' # String | 
+}
+
+begin
+  # index
+  result = api_instance.api_v1_biomarker_assay_whitespace_get(opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ApiV1BiomarkerAssayWhitespaceApi->api_v1_biomarker_assay_whitespace_get: #{e}"
+end
+```
+
+#### Using the api_v1_biomarker_assay_whitespace_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV1BiomarkerAssayWhitespaceGet200Response>, Integer, Hash)> api_v1_biomarker_assay_whitespace_get_with_http_info(opts)
+
+```ruby
+begin
+  # index
+  data, status_code, headers = api_instance.api_v1_biomarker_assay_whitespace_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV1BiomarkerAssayWhitespaceGet200Response>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ApiV1BiomarkerAssayWhitespaceApi->api_v1_biomarker_assay_whitespace_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bucket** | **String** |  | [optional] |
+| **gene** | **String** |  | [optional] |
+| **gene_evidence_tier** | **String** |  | [optional] |
+| **gene_supply_status** | **String** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **q** | **String** |  | [optional] |
+
+### Return type
+
+[**ApiV1BiomarkerAssayWhitespaceGet200Response**](ApiV1BiomarkerAssayWhitespaceGet200Response.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ApiV1BiomarkerAssayWhitespaceGet200Response.md

@@ -0,0 +1,76 @@
+# PharmaObservatory::ApiV1BiomarkerAssayWhitespaceGet200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** |  |  |
+| **gene** | **String** |  | [optional] |
+| **gene_recognized** | **Boolean** |  | [optional] |
+| **in_population** | **Boolean** |  | [optional] |
+| **build_state** | [**ApiV1BiomarkerAssayScreenGet200ResponseBuildState**](ApiV1BiomarkerAssayScreenGet200ResponseBuildState.md) |  |  |
+| **filters** | [**ApiV1BiomarkerAssayWhitespaceGet200ResponseFilters**](ApiV1BiomarkerAssayWhitespaceGet200ResponseFilters.md) |  | [optional] |
+| **bucket_counts** | [**ApiV1BiomarkerAssayWhitespaceGet200ResponseBucketCounts**](ApiV1BiomarkerAssayWhitespaceGet200ResponseBucketCounts.md) |  | [optional] |
+| **n_genes_matching** | **Integer** |  | [optional] |
+| **n_genes_returned** | **Integer** |  | [optional] |
+| **truncated** | **Boolean** |  | [optional] |
+| **genes** | [**Array<ApiV1BiomarkerAssayWhitespaceGet200ResponseGenesInner>**](ApiV1BiomarkerAssayWhitespaceGet200ResponseGenesInner.md) |  | [optional] |
+| **profile_link** | [**ApiV1BiomarkerAssayWhitespaceGet200ResponseProfileLink**](ApiV1BiomarkerAssayWhitespaceGet200ResponseProfileLink.md) |  | [optional] |
+| **gene_symbol** | **String** |  | [optional] |
+| **biomarker_display_name** | **String** |  | [optional] |
+| **whitespace_bucket** | **String** |  | [optional] |
+| **whitespace_bucket_label** | **String** |  | [optional] |
+| **whitespace_bucket_rule_id** | **String** |  | [optional] |
+| **gene_evidence_tier** | **String** |  | [optional] |
+| **gene_evidence_tier_label** | **String** |  | [optional] |
+| **gene_supply_status** | **String** |  | [optional] |
+| **gene_supply_status_label** | **String** |  | [optional] |
+| **pipeline_program_count** | **Object** |  | [optional] |
+| **pipeline_max_phase** | **Object** |  | [optional] |
+| **validated_evidence** | [**Array<ApiV1BiomarkerAssayWhitespaceGet200ResponseValidatedEvidenceInner>**](ApiV1BiomarkerAssayWhitespaceGet200ResponseValidatedEvidenceInner.md) |  | [optional] |
+| **literature_evidence** | [**Array<ApiV1BiomarkerAssayWhitespaceGet200ResponseLiteratureEvidenceInner>**](ApiV1BiomarkerAssayWhitespaceGet200ResponseLiteratureEvidenceInner.md) |  | [optional] |
+| **confidence_caveat** | **String** |  | [optional] |
+| **supplier_declarations** | [**Array<ApiV1BiomarkerAssayWhitespaceGet200ResponseSupplierDeclarationsInner>**](ApiV1BiomarkerAssayWhitespaceGet200ResponseSupplierDeclarationsInner.md) |  | [optional] |
+| **validated_evidence_built** | **Boolean** |  | [optional] |
+| **literature_evidence_built** | **Boolean** |  | [optional] |
+| **supplier_declarations_built** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ApiV1BiomarkerAssayWhitespaceGet200Response.new(
+  mode: null,
+  gene: null,
+  gene_recognized: null,
+  in_population: null,
+  build_state: null,
+  filters: null,
+  bucket_counts: null,
+  n_genes_matching: null,
+  n_genes_returned: null,
+  truncated: null,
+  genes: null,
+  profile_link: null,
+  gene_symbol: null,
+  biomarker_display_name: null,
+  whitespace_bucket: null,
+  whitespace_bucket_label: null,
+  whitespace_bucket_rule_id: null,
+  gene_evidence_tier: null,
+  gene_evidence_tier_label: null,
+  gene_supply_status: null,
+  gene_supply_status_label: null,
+  pipeline_program_count: null,
+  pipeline_max_phase: null,
+  validated_evidence: null,
+  literature_evidence: null,
+  confidence_caveat: null,
+  supplier_declarations: null,
+  validated_evidence_built: null,
+  literature_evidence_built: null,
+  supplier_declarations_built: null
+)
+```
+

data/docs/ApiV1BiomarkerAssayWhitespaceGet200ResponseBucketCounts.md

@@ -0,0 +1,34 @@
+# PharmaObservatory::ApiV1BiomarkerAssayWhitespaceGet200ResponseBucketCounts
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **no_evidence_no_supply** | **Integer** |  |  |
+| **no_evidence_supply_ambiguous** | **Integer** |  |  |
+| **supply_no_evidence** | **Integer** |  |  |
+| **literature_evidence_no_supply** | **Integer** |  |  |
+| **literature_evidence_supply_ambiguous** | **Integer** |  |  |
+| **literature_evidence_served** | **Integer** |  |  |
+| **validated_evidence_no_supply** | **Integer** |  |  |
+| **validated_evidence_supply_ambiguous** | **Integer** |  |  |
+| **served** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ApiV1BiomarkerAssayWhitespaceGet200ResponseBucketCounts.new(
+  no_evidence_no_supply: null,
+  no_evidence_supply_ambiguous: null,
+  supply_no_evidence: null,
+  literature_evidence_no_supply: null,
+  literature_evidence_supply_ambiguous: null,
+  literature_evidence_served: null,
+  validated_evidence_no_supply: null,
+  validated_evidence_supply_ambiguous: null,
+  served: null
+)
+```
+

data/docs/ApiV1BiomarkerAssayWhitespaceGet200ResponseFilters.md

@@ -0,0 +1,26 @@
+# PharmaObservatory::ApiV1BiomarkerAssayWhitespaceGet200ResponseFilters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bucket** | **String** |  |  |
+| **gene_evidence_tier** | **String** |  |  |
+| **gene_supply_status** | **String** |  |  |
+| **q** | **String** |  |  |
+| **limit** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ApiV1BiomarkerAssayWhitespaceGet200ResponseFilters.new(
+  bucket: null,
+  gene_evidence_tier: null,
+  gene_supply_status: null,
+  q: null,
+  limit: null
+)
+```
+

data/docs/ApiV1BiomarkerAssayWhitespaceGet200ResponseGenesInner.md

@@ -0,0 +1,38 @@
+# PharmaObservatory::ApiV1BiomarkerAssayWhitespaceGet200ResponseGenesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **gene_symbol** | **String** |  |  |
+| **biomarker_display_name** | **String** |  |  |
+| **whitespace_bucket** | **String** |  |  |
+| **whitespace_bucket_label** | **String** |  |  |
+| **whitespace_bucket_rule_id** | **String** |  |  |
+| **gene_evidence_tier** | **String** |  |  |
+| **gene_evidence_tier_label** | **String** |  |  |
+| **gene_supply_status** | **String** |  |  |
+| **gene_supply_status_label** | **String** |  |  |
+| **pipeline_program_count** | **Object** |  |  |
+| **pipeline_max_phase** | **Object** |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ApiV1BiomarkerAssayWhitespaceGet200ResponseGenesInner.new(
+  gene_symbol: null,
+  biomarker_display_name: null,
+  whitespace_bucket: null,
+  whitespace_bucket_label: null,
+  whitespace_bucket_rule_id: null,
+  gene_evidence_tier: null,
+  gene_evidence_tier_label: null,
+  gene_supply_status: null,
+  gene_supply_status_label: null,
+  pipeline_program_count: null,
+  pipeline_max_phase: null
+)
+```
+

data/docs/ApiV1BiomarkerAssayWhitespaceGet200ResponseLiteratureEvidenceInner.md

@@ -0,0 +1,24 @@
+# PharmaObservatory::ApiV1BiomarkerAssayWhitespaceGet200ResponseLiteratureEvidenceInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pmid** | **String** |  |  |
+| **assay_name** | **String** |  |  |
+| **evidence_quote** | **Array<String>** |  |  |
+| **confidence** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ApiV1BiomarkerAssayWhitespaceGet200ResponseLiteratureEvidenceInner.new(
+  pmid: null,
+  assay_name: null,
+  evidence_quote: null,
+  confidence: null
+)
+```
+

data/docs/ApiV1BiomarkerAssayWhitespaceGet200ResponseProfileLink.md

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

data/docs/ApiV1BiomarkerAssayWhitespaceGet200ResponseSupplierDeclarationsInner.md

@@ -0,0 +1,22 @@
+# PharmaObservatory::ApiV1BiomarkerAssayWhitespaceGet200ResponseSupplierDeclarationsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_name_raw** | **String** |  |  |
+| **assay_status** | **String** |  |  |
+| **assay_status_label** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ApiV1BiomarkerAssayWhitespaceGet200ResponseSupplierDeclarationsInner.new(
+  company_name_raw: null,
+  assay_status: null,
+  assay_status_label: null
+)
+```
+

data/docs/ApiV1BiomarkerAssayWhitespaceGet200ResponseValidatedEvidenceInner.md

@@ -0,0 +1,34 @@
+# PharmaObservatory::ApiV1BiomarkerAssayWhitespaceGet200ResponseValidatedEvidenceInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_name** | **Object** |  |  |
+| **org_role** | **String** |  |  |
+| **role_label** | **String** |  |  |
+| **tier_label** | **String** |  |  |
+| **tier_label_copy** | **String** |  |  |
+| **evidence_type** | **String** |  |  |
+| **evidence_type_label** | **String** |  |  |
+| **citation_url** | **String** |  |  |
+| **citation_verified** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ApiV1BiomarkerAssayWhitespaceGet200ResponseValidatedEvidenceInner.new(
+  org_name: null,
+  org_role: null,
+  role_label: null,
+  tier_label: null,
+  tier_label_copy: null,
+  evidence_type: null,
+  evidence_type_label: null,
+  citation_url: null,
+  citation_verified: null
+)
+```
+

data/docs/ApiV1CandidateSiteApi.md

@@ -0,0 +1,83 @@
+# PharmaObservatory::ApiV1CandidateSiteApi
+
+All URIs are relative to *https://pharmaobservatory.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_v1_candidate_sites_get**](ApiV1CandidateSiteApi.md#api_v1_candidate_sites_get) | **GET** /api/v1/candidate_sites | Rank candidate clinical trial sites for a condition by composite capacity, activity, and competition scores |
+
+
+## api_v1_candidate_sites_get
+
+> <ApiV1CandidateSitesGet200Response> api_v1_candidate_sites_get(opts)
+
+Rank candidate clinical trial sites for a condition by composite capacity, activity, and competition scores
+
+### 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::ApiV1CandidateSiteApi.new
+opts = {
+  condition_id: 'D001523', # String | 
+  country: 'United States', # String | 
+  exclude_saturated: true, # Boolean | 
+  limit: 500 # Integer | 
+}
+
+begin
+  # Rank candidate clinical trial sites for a condition by composite capacity, activity, and competition scores
+  result = api_instance.api_v1_candidate_sites_get(opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ApiV1CandidateSiteApi->api_v1_candidate_sites_get: #{e}"
+end
+```
+
+#### Using the api_v1_candidate_sites_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiV1CandidateSitesGet200Response>, Integer, Hash)> api_v1_candidate_sites_get_with_http_info(opts)
+
+```ruby
+begin
+  # Rank candidate clinical trial sites for a condition by composite capacity, activity, and competition scores
+  data, status_code, headers = api_instance.api_v1_candidate_sites_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiV1CandidateSitesGet200Response>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ApiV1CandidateSiteApi->api_v1_candidate_sites_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **condition_id** | **String** |  | [optional] |
+| **country** | **String** |  | [optional] |
+| **exclude_saturated** | **Boolean** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+
+### Return type
+
+[**ApiV1CandidateSitesGet200Response**](ApiV1CandidateSitesGet200Response.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ApiV1CandidateSitesGet200Response.md

@@ -0,0 +1,32 @@
+# PharmaObservatory::ApiV1CandidateSitesGet200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filters** | [**ApiV1CandidateSitesGet200ResponseFilters**](ApiV1CandidateSitesGet200ResponseFilters.md) |  | [optional] |
+| **matched_count** | **Integer** |  | [optional] |
+| **saturated_count** | **Integer** |  | [optional] |
+| **returned_count** | **Integer** |  | [optional] |
+| **sites** | [**Array<ApiV1CandidateSitesGet200ResponseSitesInner>**](ApiV1CandidateSitesGet200ResponseSitesInner.md) |  | [optional] |
+| **build_state** | [**ApiV1BiomarkerAssayScreenGet200ResponseBuildState**](ApiV1BiomarkerAssayScreenGet200ResponseBuildState.md) |  |  |
+| **error** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ApiV1CandidateSitesGet200Response.new(
+  filters: null,
+  matched_count: null,
+  saturated_count: null,
+  returned_count: null,
+  sites: null,
+  build_state: null,
+  error: null,
+  message: null
+)
+```
+

data/docs/ApiV1CandidateSitesGet200ResponseFilters.md

@@ -0,0 +1,22 @@
+# PharmaObservatory::ApiV1CandidateSitesGet200ResponseFilters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **condition_id** | **String** |  |  |
+| **country** | **String** |  |  |
+| **exclude_saturated** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ApiV1CandidateSitesGet200ResponseFilters.new(
+  condition_id: null,
+  country: null,
+  exclude_saturated: null
+)
+```
+

data/docs/ApiV1CandidateSitesGet200ResponseSitesInner.md

@@ -0,0 +1,46 @@
+# PharmaObservatory::ApiV1CandidateSitesGet200ResponseSitesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **rank** | **Integer** |  |  |
+| **site_key** | **String** |  |  |
+| **facility_name** | **String** |  |  |
+| **city** | **String** |  |  |
+| **state** | **String** |  |  |
+| **country** | **String** |  |  |
+| **n_trials_in_indication** | **Integer** |  |  |
+| **estimated_patients_in_indication** | **String** |  |  |
+| **n_active_in_indication** | **Integer** |  |  |
+| **n_active_same_phase** | **Object** |  |  |
+| **composite_score** | **Float** |  |  |
+| **capacity_z** | **Float** |  |  |
+| **activity_z** | **Float** |  |  |
+| **competition_z** | **Float** |  |  |
+| **saturated** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ApiV1CandidateSitesGet200ResponseSitesInner.new(
+  rank: null,
+  site_key: null,
+  facility_name: null,
+  city: null,
+  state: null,
+  country: null,
+  n_trials_in_indication: null,
+  estimated_patients_in_indication: null,
+  n_active_in_indication: null,
+  n_active_same_phase: null,
+  composite_score: null,
+  capacity_z: null,
+  activity_z: null,
+  competition_z: null,
+  saturated: null
+)
+```
+