pharmaobservatory 0.1.0 → 0.1.2

data/docs/BiomarkersTrialMention200ResponseRowsInner.md

@@ -0,0 +1,26 @@
+# PharmaObservatory::BiomarkersTrialMention200ResponseRowsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **nct_id** | **String** |  |  |
+| **disease** | **Object** |  |  |
+| **sample_type** | **String** |  |  |
+| **source** | **String** |  |  |
+| **source_label** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::BiomarkersTrialMention200ResponseRowsInner.new(
+  nct_id: null,
+  disease: null,
+  sample_type: null,
+  source: null,
+  source_label: null
+)
+```
+

data/docs/BiomarkersVariantMentions200Response.md

@@ -0,0 +1,40 @@
+# PharmaObservatory::BiomarkersVariantMentions200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **String** |  |  |
+| **id** | **String** |  |  |
+| **section** | **String** |  |  |
+| **heading** | **String** |  |  |
+| **lens** | **Object** |  |  |
+| **web_url** | **String** |  |  |
+| **shape** | [**BiomarkersList200ResponseShape**](BiomarkersList200ResponseShape.md) |  |  |
+| **columns** | [**Array<BiomarkersList200ResponseColumnsInner>**](BiomarkersList200ResponseColumnsInner.md) |  |  |
+| **rows** | [**Array<BiomarkersVariantMentions200ResponseRowsInner>**](BiomarkersVariantMentions200ResponseRowsInner.md) |  |  |
+| **attribution** | [**Array<BiomarkersAssayProviderLedger200ResponseAttributionInner>**](BiomarkersAssayProviderLedger200ResponseAttributionInner.md) |  |  |
+| **pagination** | [**BiomarkersAssayProviderLedger200ResponsePagination**](BiomarkersAssayProviderLedger200ResponsePagination.md) |  |  |
+| **build_state** | [**BiomarkersList200ResponseBuildState**](BiomarkersList200ResponseBuildState.md) |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::BiomarkersVariantMentions200Response.new(
+  page: null,
+  id: null,
+  section: null,
+  heading: null,
+  lens: null,
+  web_url: null,
+  shape: null,
+  columns: null,
+  rows: null,
+  attribution: null,
+  pagination: null,
+  build_state: null
+)
+```
+

data/docs/BiomarkersVariantMentions200ResponseRowsInner.md

@@ -0,0 +1,28 @@
+# PharmaObservatory::BiomarkersVariantMentions200ResponseRowsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **biomarker_id** | **String** |  |  |
+| **amino_acid_change** | **String** |  |  |
+| **n_papers** | **Integer** |  |  |
+| **first_publication_year** | **Integer** |  |  |
+| **last_publication_year** | **Integer** |  |  |
+| **sample_pmids** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::BiomarkersVariantMentions200ResponseRowsInner.new(
+  biomarker_id: null,
+  amino_acid_change: null,
+  n_papers: null,
+  first_publication_year: null,
+  last_publication_year: null,
+  sample_pmids: null
+)
+```
+

data/docs/BiomarkersVendorSourcing200Response.md

@@ -0,0 +1,42 @@
+# PharmaObservatory::BiomarkersVendorSourcing200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **String** |  |  |
+| **id** | **String** |  |  |
+| **section** | **String** |  |  |
+| **heading** | **String** |  |  |
+| **lens** | **Object** |  |  |
+| **web_url** | **String** |  |  |
+| **shape** | [**BiomarkersList200ResponseShape**](BiomarkersList200ResponseShape.md) |  |  |
+| **columns** | [**Array<BiomarkersList200ResponseColumnsInner>**](BiomarkersList200ResponseColumnsInner.md) |  |  |
+| **rows** | [**Array<BiomarkersVendorSourcing200ResponseRowsInner>**](BiomarkersVendorSourcing200ResponseRowsInner.md) |  |  |
+| **attribution** | [**Array<BiomarkersList200ResponseAttributionInner>**](BiomarkersList200ResponseAttributionInner.md) |  |  |
+| **pagination** | [**BiomarkersAssayProviderLedger200ResponsePagination**](BiomarkersAssayProviderLedger200ResponsePagination.md) |  |  |
+| **query** | [**BiomarkersVendorSourcing200ResponseQuery**](BiomarkersVendorSourcing200ResponseQuery.md) |  |  |
+| **build_state** | [**BiomarkersList200ResponseBuildState**](BiomarkersList200ResponseBuildState.md) |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::BiomarkersVendorSourcing200Response.new(
+  page: null,
+  id: null,
+  section: null,
+  heading: null,
+  lens: null,
+  web_url: null,
+  shape: null,
+  columns: null,
+  rows: null,
+  attribution: null,
+  pagination: null,
+  query: null,
+  build_state: null
+)
+```
+

data/docs/BiomarkersVendorSourcing200ResponseQuery.md

@@ -0,0 +1,18 @@
+# PharmaObservatory::BiomarkersVendorSourcing200ResponseQuery
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filters** | **Object** |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::BiomarkersVendorSourcing200ResponseQuery.new(
+  filters: null
+)
+```
+

data/docs/BiomarkersVendorSourcing200ResponseRowsInner.md

@@ -0,0 +1,46 @@
+# PharmaObservatory::BiomarkersVendorSourcing200ResponseRowsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_name** | **String** |  |  |
+| **canonical_org_id** | **String** |  |  |
+| **resolved_parent_id** | **String** |  |  |
+| **org_role** | **String** |  |  |
+| **role_label** | **String** |  |  |
+| **tier** | **Integer** |  |  |
+| **tier_label** | **String** |  |  |
+| **tier_label_copy** | **String** |  |  |
+| **evidence_type** | **String** |  |  |
+| **evidence_type_label** | **String** |  |  |
+| **evidence_count** | **Integer** |  |  |
+| **clinvar_scv_count** | **Object** |  |  |
+| **evidence_ref_kind** | **String** |  |  |
+| **citation_url** | **String** |  |  |
+| **citation_verified** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::BiomarkersVendorSourcing200ResponseRowsInner.new(
+  org_name: null,
+  canonical_org_id: null,
+  resolved_parent_id: null,
+  org_role: null,
+  role_label: null,
+  tier: null,
+  tier_label: null,
+  tier_label_copy: null,
+  evidence_type: null,
+  evidence_type_label: null,
+  evidence_count: null,
+  clinvar_scv_count: null,
+  evidence_ref_kind: null,
+  citation_url: null,
+  citation_verified: null
+)
+```
+

data/docs/BiomarkersWhereItAppears200Response.md

@@ -0,0 +1,38 @@
+# PharmaObservatory::BiomarkersWhereItAppears200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **String** |  |  |
+| **id** | **String** |  |  |
+| **section** | **String** |  |  |
+| **heading** | **String** |  |  |
+| **lens** | **Object** |  |  |
+| **web_url** | **String** |  |  |
+| **shape** | [**BiomarkersList200ResponseShape**](BiomarkersList200ResponseShape.md) |  |  |
+| **columns** | [**Array<BiomarkersList200ResponseColumnsInner>**](BiomarkersList200ResponseColumnsInner.md) |  |  |
+| **rows** | [**Array<BiomarkersWhereItAppears200ResponseRowsInner>**](BiomarkersWhereItAppears200ResponseRowsInner.md) |  |  |
+| **attribution** | [**Array<BiomarkersCgi200ResponseAttributionInner>**](BiomarkersCgi200ResponseAttributionInner.md) |  |  |
+| **build_state** | [**BiomarkersList200ResponseBuildState**](BiomarkersList200ResponseBuildState.md) |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::BiomarkersWhereItAppears200Response.new(
+  page: null,
+  id: null,
+  section: null,
+  heading: null,
+  lens: null,
+  web_url: null,
+  shape: null,
+  columns: null,
+  rows: null,
+  attribution: null,
+  build_state: null
+)
+```
+

data/docs/BiomarkersWhereItAppears200ResponseRowsInner.md

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

data/docs/CellLinesApi.md

@@ -0,0 +1,357 @@
+# PharmaObservatory::CellLinesApi
+
+All URIs are relative to *https://pharmaobservatory.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**cell_lines_get**](CellLinesApi.md#cell_lines_get) | **GET** /api/v1/cell-lines/{id} | One cell-lines record |
+| [**cell_lines_identity**](CellLinesApi.md#cell_lines_identity) | **GET** /api/v1/cell-lines/{id}/identity | Identity and availability |
+| [**cell_lines_list**](CellLinesApi.md#cell_lines_list) | **GET** /api/v1/cell-lines | Cell line identity safety |
+| [**cell_lines_safety_resolution**](CellLinesApi.md#cell_lines_safety_resolution) | **GET** /api/v1/cell-lines/{id}/safety_resolution | Safety resolution |
+| [**cell_lines_status_counts**](CellLinesApi.md#cell_lines_status_counts) | **GET** /api/v1/cell-lines/status_counts | Cell line safety summary |
+
+
+## cell_lines_get
+
+> <CellLinesGet200Response> cell_lines_get(id)
+
+One cell-lines record
+
+### 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::CellLinesApi.new
+id = 'SCI-CONF' # String | 
+
+begin
+  # One cell-lines record
+  result = api_instance.cell_lines_get(id)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling CellLinesApi->cell_lines_get: #{e}"
+end
+```
+
+#### Using the cell_lines_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CellLinesGet200Response>, Integer, Hash)> cell_lines_get_with_http_info(id)
+
+```ruby
+begin
+  # One cell-lines record
+  data, status_code, headers = api_instance.cell_lines_get_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CellLinesGet200Response>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling CellLinesApi->cell_lines_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**CellLinesGet200Response**](CellLinesGet200Response.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## cell_lines_identity
+
+> <CellLinesIdentity200Response> cell_lines_identity(id)
+
+Identity and availability
+
+### 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::CellLinesApi.new
+id = 'SCI-CONF' # String | 
+
+begin
+  # Identity and availability
+  result = api_instance.cell_lines_identity(id)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling CellLinesApi->cell_lines_identity: #{e}"
+end
+```
+
+#### Using the cell_lines_identity_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CellLinesIdentity200Response>, Integer, Hash)> cell_lines_identity_with_http_info(id)
+
+```ruby
+begin
+  # Identity and availability
+  data, status_code, headers = api_instance.cell_lines_identity_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CellLinesIdentity200Response>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling CellLinesApi->cell_lines_identity_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**CellLinesIdentity200Response**](CellLinesIdentity200Response.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## cell_lines_list
+
+> <CellLinesList200Response> cell_lines_list(opts)
+
+Cell line identity safety
+
+### 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::CellLinesApi.new
+opts = {
+  cursor: 'eyJwIjoyLCJsIjoyLCJmIjoic3BlYy1maW5nZXJwcmludCJ9', # String | 
+  facets: true, # Boolean | 
+  limit: 1, # Integer | 
+  safety_status: 'confirmed_problematic' # String | 
+}
+
+begin
+  # Cell line identity safety
+  result = api_instance.cell_lines_list(opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling CellLinesApi->cell_lines_list: #{e}"
+end
+```
+
+#### Using the cell_lines_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CellLinesList200Response>, Integer, Hash)> cell_lines_list_with_http_info(opts)
+
+```ruby
+begin
+  # Cell line identity safety
+  data, status_code, headers = api_instance.cell_lines_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CellLinesList200Response>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling CellLinesApi->cell_lines_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cursor** | **String** |  | [optional] |
+| **facets** | **Boolean** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **safety_status** | **String** |  | [optional] |
+
+### Return type
+
+[**CellLinesList200Response**](CellLinesList200Response.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## cell_lines_safety_resolution
+
+> <CellLinesSafetyResolution200Response> cell_lines_safety_resolution(id)
+
+Safety resolution
+
+### 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::CellLinesApi.new
+id = 'SCI-CONF' # String | 
+
+begin
+  # Safety resolution
+  result = api_instance.cell_lines_safety_resolution(id)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling CellLinesApi->cell_lines_safety_resolution: #{e}"
+end
+```
+
+#### Using the cell_lines_safety_resolution_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CellLinesSafetyResolution200Response>, Integer, Hash)> cell_lines_safety_resolution_with_http_info(id)
+
+```ruby
+begin
+  # Safety resolution
+  data, status_code, headers = api_instance.cell_lines_safety_resolution_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CellLinesSafetyResolution200Response>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling CellLinesApi->cell_lines_safety_resolution_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**CellLinesSafetyResolution200Response**](CellLinesSafetyResolution200Response.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## cell_lines_status_counts
+
+> <CellLinesStatusCounts200Response> cell_lines_status_counts(opts)
+
+Cell line safety summary
+
+### 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::CellLinesApi.new
+opts = {
+  species: 'Mouse' # String | 
+}
+
+begin
+  # Cell line safety summary
+  result = api_instance.cell_lines_status_counts(opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling CellLinesApi->cell_lines_status_counts: #{e}"
+end
+```
+
+#### Using the cell_lines_status_counts_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CellLinesStatusCounts200Response>, Integer, Hash)> cell_lines_status_counts_with_http_info(opts)
+
+```ruby
+begin
+  # Cell line safety summary
+  data, status_code, headers = api_instance.cell_lines_status_counts_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CellLinesStatusCounts200Response>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling CellLinesApi->cell_lines_status_counts_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **species** | **String** |  | [optional] |
+
+### Return type
+
+[**CellLinesStatusCounts200Response**](CellLinesStatusCounts200Response.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CellLinesGet200Response.md

@@ -0,0 +1,32 @@
+# PharmaObservatory::CellLinesGet200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **String** |  |  |
+| **id** | **String** |  |  |
+| **identity** | [**CellLinesGet200ResponseIdentity**](CellLinesGet200ResponseIdentity.md) |  |  |
+| **sections** | [**Array<BiomarkersGet200ResponseSectionsInner>**](BiomarkersGet200ResponseSectionsInner.md) |  |  |
+| **attribution** | [**Array<CellLinesList200ResponseAttributionInner>**](CellLinesList200ResponseAttributionInner.md) |  |  |
+| **web_url** | **String** |  |  |
+| **build_state** | [**BiomarkersList200ResponseBuildState**](BiomarkersList200ResponseBuildState.md) |  |  |
+| **resolution_confidence** | [**BiomarkersGet200ResponseResolutionConfidence**](BiomarkersGet200ResponseResolutionConfidence.md) |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::CellLinesGet200Response.new(
+  page: null,
+  id: null,
+  identity: null,
+  sections: null,
+  attribution: null,
+  web_url: null,
+  build_state: null,
+  resolution_confidence: null
+)
+```
+

data/docs/CellLinesGet200ResponseIdentity.md

@@ -0,0 +1,20 @@
+# PharmaObservatory::CellLinesGet200ResponseIdentity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **columns** | [**Array<BiomarkersList200ResponseColumnsInner>**](BiomarkersList200ResponseColumnsInner.md) |  |  |
+| **rows** | [**Array<CellLinesGet200ResponseIdentityRowsInner>**](CellLinesGet200ResponseIdentityRowsInner.md) |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::CellLinesGet200ResponseIdentity.new(
+  columns: null,
+  rows: null
+)
+```
+

data/docs/CellLinesGet200ResponseIdentityRowsInner.md

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