pharmaobservatory 0.1.6 → 0.1.8

data/docs/BiomarkersApi.md

@@ -4,22 +4,105 @@ All URIs are relative to *https://pharmaobservatory.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**biomarkers_biomarker_allele_frequencies**](BiomarkersApi.md#biomarkers_biomarker_allele_frequencies) | **GET** /api/v1/biomarkers/{id}/biomarker_allele_frequencies | Population allele frequency of protein variants (gnomAD) |
 | [**biomarkers_biomarker_assay_evidence**](BiomarkersApi.md#biomarkers_biomarker_assay_evidence) | **GET** /api/v1/biomarkers/{id}/biomarker_assay_evidence | Biomarker assay evidence from the literature |
+| [**biomarkers_biomarker_assay_providers**](BiomarkersApi.md#biomarkers_biomarker_assay_providers) | **GET** /api/v1/biomarkers/{id}/biomarker_assay_providers | Biomarker assay providers (from validating papers) |
 | [**biomarkers_biomarker_assay_whitespace**](BiomarkersApi.md#biomarkers_biomarker_assay_whitespace) | **GET** /api/v1/biomarkers/{id}/biomarker_assay_whitespace | Biomarker assay whitespace (evidence against supplier supply) |
 | [**biomarkers_biomarker_bqp_assertions**](BiomarkersApi.md#biomarkers_biomarker_bqp_assertions) | **GET** /api/v1/biomarkers/{id}/biomarker_bqp_assertions | FDA biomarker qualification projects |
 | [**biomarkers_biomarker_cdx_assertions**](BiomarkersApi.md#biomarkers_biomarker_cdx_assertions) | **GET** /api/v1/biomarkers/{id}/biomarker_cdx_assertions | FDA companion diagnostic assertions |
 | [**biomarkers_biomarker_evidence**](BiomarkersApi.md#biomarkers_biomarker_evidence) | **GET** /api/v1/biomarkers/{id}/biomarker_evidence | Biomarker evidence |
+| [**biomarkers_biomarker_evidence_by_year**](BiomarkersApi.md#biomarkers_biomarker_evidence_by_year) | **GET** /api/v1/biomarkers/{id}/biomarker_evidence_by_year | Biomarker evidence by year (trial and publication mentions) |
 | [**biomarkers_biomarker_literature**](BiomarkersApi.md#biomarkers_biomarker_literature) | **GET** /api/v1/biomarkers/{id}/biomarker_literature | Trial-cited literature mentions |
 | [**biomarkers_biomarker_publishing_companies**](BiomarkersApi.md#biomarkers_biomarker_publishing_companies) | **GET** /api/v1/biomarkers/{id}/biomarker_publishing_companies | Companies publishing on a biomarker |
 | [**biomarkers_biomarker_relations**](BiomarkersApi.md#biomarkers_biomarker_relations) | **GET** /api/v1/biomarkers/{id}/biomarker_relations | Literature-extracted relations |
 | [**biomarkers_biomarker_sample_coverage**](BiomarkersApi.md#biomarkers_biomarker_sample_coverage) | **GET** /api/v1/biomarkers/{id}/biomarker_sample_coverage | Human sample screening coverage (GDC) |
 | [**biomarkers_biomarker_sample_prevalence**](BiomarkersApi.md#biomarkers_biomarker_sample_prevalence) | **GET** /api/v1/biomarkers/{id}/biomarker_sample_prevalence | Human sample screening reference (GDC cohorts) |
+| [**biomarkers_biomarker_traversal_status**](BiomarkersApi.md#biomarkers_biomarker_traversal_status) | **GET** /api/v1/biomarkers/{id}/biomarker_traversal_status | Biomarker coverage by traversal |
 | [**biomarkers_biomarker_validation**](BiomarkersApi.md#biomarkers_biomarker_validation) | **GET** /api/v1/biomarkers/{id}/biomarker_validation | Biomarker validation ladder |
 | [**biomarkers_biomarker_variant_mentions**](BiomarkersApi.md#biomarkers_biomarker_variant_mentions) | **GET** /api/v1/biomarkers/{id}/biomarker_variant_mentions | Protein variant mentions |
 | [**biomarkers_get**](BiomarkersApi.md#biomarkers_get) | **GET** /api/v1/biomarkers/{id} | One biomarker |
 | [**biomarkers_list**](BiomarkersApi.md#biomarkers_list) | **GET** /api/v1/biomarkers | List biomarkers |
 
 
+## biomarkers_biomarker_allele_frequencies
+
+> <BiomarkerAlleleFrequenciesResponse> biomarkers_biomarker_allele_frequencies(id, opts)
+
+Population allele frequency of protein variants (gnomAD)
+
+### 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::BiomarkersApi.new
+id = 'ESR1' # String | 
+opts = {
+  cursor: 'cursor_example', # String | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
+  limit: 56, # Integer | Rows per page, up to 500 (default 50).
+  sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
+  group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
+  measure: 'measure_example' # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
+}
+
+begin
+  # Population allele frequency of protein variants (gnomAD)
+  result = api_instance.biomarkers_biomarker_allele_frequencies(id, opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling BiomarkersApi->biomarkers_biomarker_allele_frequencies: #{e}"
+end
+```
+
+#### Using the biomarkers_biomarker_allele_frequencies_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BiomarkerAlleleFrequenciesResponse>, Integer, Hash)> biomarkers_biomarker_allele_frequencies_with_http_info(id, opts)
+
+```ruby
+begin
+  # Population allele frequency of protein variants (gnomAD)
+  data, status_code, headers = api_instance.biomarkers_biomarker_allele_frequencies_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BiomarkerAlleleFrequenciesResponse>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling BiomarkersApi->biomarkers_biomarker_allele_frequencies_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
+| **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
+| **sort** | **String** | Comma separated columns, a leading minus for descending: sort&#x3D;a,-b. | [optional] |
+| **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
+| **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
+
+### Return type
+
+[**BiomarkerAlleleFrequenciesResponse**](BiomarkerAlleleFrequenciesResponse.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## biomarkers_biomarker_assay_evidence
 
 > <BiomarkerAssayEvidenceResponse> biomarkers_biomarker_assay_evidence(id, opts)
@@ -99,6 +182,85 @@ end
 - **Accept**: application/json
 
 
+## biomarkers_biomarker_assay_providers
+
+> <BiomarkerAssayProvidersResponse> biomarkers_biomarker_assay_providers(id, opts)
+
+Biomarker assay providers (from validating papers)
+
+### 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::BiomarkersApi.new
+id = 'ESR1' # String | 
+opts = {
+  cursor: 'cursor_example', # String | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
+  limit: 56, # Integer | Rows per page, up to 500 (default 50).
+  sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
+  group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
+  measure: 'measure_example' # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
+}
+
+begin
+  # Biomarker assay providers (from validating papers)
+  result = api_instance.biomarkers_biomarker_assay_providers(id, opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling BiomarkersApi->biomarkers_biomarker_assay_providers: #{e}"
+end
+```
+
+#### Using the biomarkers_biomarker_assay_providers_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BiomarkerAssayProvidersResponse>, Integer, Hash)> biomarkers_biomarker_assay_providers_with_http_info(id, opts)
+
+```ruby
+begin
+  # Biomarker assay providers (from validating papers)
+  data, status_code, headers = api_instance.biomarkers_biomarker_assay_providers_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BiomarkerAssayProvidersResponse>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling BiomarkersApi->biomarkers_biomarker_assay_providers_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
+| **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
+| **sort** | **String** | Comma separated columns, a leading minus for descending: sort&#x3D;a,-b. | [optional] |
+| **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
+| **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
+
+### Return type
+
+[**BiomarkerAssayProvidersResponse**](BiomarkerAssayProvidersResponse.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## biomarkers_biomarker_assay_whitespace
 
 > <BiomarkerAssayWhitespaceResponse> biomarkers_biomarker_assay_whitespace(id, opts)
@@ -415,6 +577,85 @@ end
 - **Accept**: application/json
 
 
+## biomarkers_biomarker_evidence_by_year
+
+> <BiomarkerEvidenceByYearResponse> biomarkers_biomarker_evidence_by_year(id, opts)
+
+Biomarker evidence by year (trial and publication mentions)
+
+### 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::BiomarkersApi.new
+id = 'ESR1' # String | 
+opts = {
+  cursor: 'cursor_example', # String | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
+  limit: 56, # Integer | Rows per page, up to 500 (default 50).
+  sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
+  group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
+  measure: 'measure_example' # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
+}
+
+begin
+  # Biomarker evidence by year (trial and publication mentions)
+  result = api_instance.biomarkers_biomarker_evidence_by_year(id, opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling BiomarkersApi->biomarkers_biomarker_evidence_by_year: #{e}"
+end
+```
+
+#### Using the biomarkers_biomarker_evidence_by_year_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BiomarkerEvidenceByYearResponse>, Integer, Hash)> biomarkers_biomarker_evidence_by_year_with_http_info(id, opts)
+
+```ruby
+begin
+  # Biomarker evidence by year (trial and publication mentions)
+  data, status_code, headers = api_instance.biomarkers_biomarker_evidence_by_year_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BiomarkerEvidenceByYearResponse>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling BiomarkersApi->biomarkers_biomarker_evidence_by_year_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
+| **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
+| **sort** | **String** | Comma separated columns, a leading minus for descending: sort&#x3D;a,-b. | [optional] |
+| **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
+| **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
+
+### Return type
+
+[**BiomarkerEvidenceByYearResponse**](BiomarkerEvidenceByYearResponse.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## biomarkers_biomarker_literature
 
 > <BiomarkerLiteratureResponse> biomarkers_biomarker_literature(id, opts)
@@ -810,6 +1051,85 @@ end
 - **Accept**: application/json
 
 
+## biomarkers_biomarker_traversal_status
+
+> <BiomarkerTraversalStatusResponse> biomarkers_biomarker_traversal_status(id, opts)
+
+Biomarker coverage by traversal
+
+### 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::BiomarkersApi.new
+id = 'ESR1' # String | 
+opts = {
+  cursor: 'cursor_example', # String | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
+  limit: 56, # Integer | Rows per page, up to 500 (default 50).
+  sort: 'sort_example', # String | Comma separated columns, a leading minus for descending: sort=a,-b.
+  group_by: 'group_by_example', # String | A dimension to group by; a date takes :year, :quarter or :month.
+  measure: 'measure_example' # String | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
+}
+
+begin
+  # Biomarker coverage by traversal
+  result = api_instance.biomarkers_biomarker_traversal_status(id, opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling BiomarkersApi->biomarkers_biomarker_traversal_status: #{e}"
+end
+```
+
+#### Using the biomarkers_biomarker_traversal_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BiomarkerTraversalStatusResponse>, Integer, Hash)> biomarkers_biomarker_traversal_status_with_http_info(id, opts)
+
+```ruby
+begin
+  # Biomarker coverage by traversal
+  data, status_code, headers = api_instance.biomarkers_biomarker_traversal_status_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BiomarkerTraversalStatusResponse>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling BiomarkersApi->biomarkers_biomarker_traversal_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **cursor** | **String** | The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it. | [optional] |
+| **limit** | **Integer** | Rows per page, up to 500 (default 50). | [optional] |
+| **sort** | **String** | Comma separated columns, a leading minus for descending: sort&#x3D;a,-b. | [optional] |
+| **group_by** | **String** | A dimension to group by; a date takes :year, :quarter or :month. | [optional] |
+| **measure** | **String** | count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col). | [optional] |
+
+### Return type
+
+[**BiomarkerTraversalStatusResponse**](BiomarkerTraversalStatusResponse.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## biomarkers_biomarker_validation
 
 > <BiomarkerValidationResponse> biomarkers_biomarker_validation(id, opts)

data/docs/BrandCompaniesResponse.md

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

@@ -0,0 +1,50 @@
+# PharmaObservatory::BrandCompaniesRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **molecule_id** | **String** | The molecule key: the resolved drug a brand, a salt form or an investigational arm resolves to, and the entry key for the drugs object type. A member id (a salt or a folded trial arm) is not a value here; it redirects to its molecule. | [optional] |
+| **brand_key** | **String** | The brand key: an upper-case alphanumeric trade-name token (the brand's leading name tokens), the same key the brands pages use. Not a display name; brand_name is the display form. | [optional] |
+| **company_role** | **String** | The applicant's role for the brand: approval_holder or generic_applicant. | [optional] |
+| **applicant_name_key** | **String** | The normalised applicant name, the grain key that separates two spellings of one applicant. | [optional] |
+| **applicant_name** | **String** | The applicant name FDA published, as filed. | [optional] |
+| **applicant_org_id** | **String** | Legal-entity level: the applicant's organization record (null when unresolved). | [optional] |
+| **applicant_company_id** | **String** | Company level: the applicant's company (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] |
+| **match_scope** | **String** | How firmly the applicant name resolved to the organization (spine_unique, anchored and establishment_registry are folded onto an organization the spine already held; anchored_scoped, registry_scoped, alias_scoped and none are newly minted organizations). Null when the applicant did not resolve. | [optional] |
+| **n_applications** | **Integer** | Distinct FDA applications the applicant holds for the brand. | [optional] |
+| **first_approval_date** | **Date** | The earliest approval date among those applications. | [optional] |
+| **latest_approval_date** | **Date** | The latest approval date among those applications. | [optional] |
+| **is_marketed_now** | **Boolean** | True when at least one of the applicant's products is currently marketed. | [optional] |
+| **source_systems** | **Array<String>** | The FDA records the applicant was read from (Drugs@FDA, Orange Book, Purple Book). | [optional] |
+| **as_of** | **Date** | The ingest snapshot date the row was read from. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::BrandCompaniesRow.new(
+  molecule_id: null,
+  brand_key: null,
+  company_role: null,
+  applicant_name_key: null,
+  applicant_name: null,
+  applicant_org_id: null,
+  applicant_company_id: null,
+  applicant_company_name: null,
+  applicant_group_id: null,
+  applicant_group_name: null,
+  match_scope: null,
+  n_applications: null,
+  first_approval_date: null,
+  latest_approval_date: null,
+  is_marketed_now: null,
+  source_systems: null,
+  as_of: null
+)
+```
+

data/docs/BrandRevenueResponse.md

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

@@ -0,0 +1,60 @@
+# PharmaObservatory::BrandRevenueRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **molecule_id** | **String** | The molecule key: the resolved drug a brand, a salt form or an investigational arm resolves to, and the entry key for the drugs object type. A member id (a salt or a folded trial arm) is not a value here; it redirects to its molecule. | [optional] |
+| **brand_key** | **String** | The brand key: an upper-case alphanumeric trade-name token (the brand's leading name tokens), the same key the brands pages use. Not a display name; brand_name is the display form. | [optional] |
+| **product_name** | **String** | The product name as filed. | [optional] |
+| **reporter_org_id** | **String** | Legal-entity level: the SEC filer that reported the figure, as filed (edgar:<CIK>). | [optional] |
+| **reporter_company_id** | **String** | Company level: the reporting company's company (null when unresolved). | [optional] |
+| **reporter_company_name** | **String** | Display name of the reporting company's company. | [optional] |
+| **reporter_group_id** | **String** | Group level: the reporting company's current ultimate parent company; a root company's group is itself. | [optional] |
+| **reporter_group_name** | **String** | Display name of the reporting company's group. | [optional] |
+| **fiscal_year** | **Integer** | The fiscal year of the figure. | [optional] |
+| **revenue_basis** | **String** | The standardised basis: worldwide, us, ex_us, region or country. | [optional] |
+| **geography** | **String** | The normalised geography: worldwide, us or ex_us for the spine (equal to the basis), the filer's own label for a region or country line. | [optional] |
+| **revenue_usd_millions** | **Float** | The figure in USD millions (null where no unit or exchange rate is available). | [optional] |
+| **revenue_amount** | **Float** | The figure as reported, in reporting_unit and revenue_currency; can be negative for adjustment or return lines. | [optional] |
+| **revenue_currency** | **String** | The filing's currency (ISO code). | [optional] |
+| **reporting_unit** | **String** | The filing's reporting unit (units, thousands, millions or billions); null when the filing did not state a readable one. | [optional] |
+| **as_reported** | **Boolean** | True when the figure comes from the filing for its own fiscal year, false when it is a comparative year read from a later filing. | [optional] |
+| **n_filings** | **Integer** | Distinct filings that report the figure. | [optional] |
+| **restated** | **Boolean** | True when several filings report the figure and differ by more than one percent. | [optional] |
+| **confidence** | **Float** | The extraction's confidence in the line, 0 to 1. | [optional] |
+| **source_url** | **String** | The link to the SEC filing the figure was extracted from. | [optional] |
+| **evidence_quote** | **String** | The sentence of the filing the figure was extracted from. | [optional] |
+| **match_method** | **String** | How the product name matched the brand: alias_prefix, product_prefix or curated_alias. A label of the mechanism, not a confidence. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::BrandRevenueRow.new(
+  molecule_id: null,
+  brand_key: null,
+  product_name: null,
+  reporter_org_id: null,
+  reporter_company_id: null,
+  reporter_company_name: null,
+  reporter_group_id: null,
+  reporter_group_name: null,
+  fiscal_year: null,
+  revenue_basis: null,
+  geography: null,
+  revenue_usd_millions: null,
+  revenue_amount: null,
+  revenue_currency: null,
+  reporting_unit: null,
+  as_reported: null,
+  n_filings: null,
+  restated: null,
+  confidence: null,
+  source_url: null,
+  evidence_quote: null,
+  match_method: null
+)
+```
+

data/docs/CatalystsResponse.md

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