pharmaobservatory 0.1.6 → 0.1.7

data/docs/RwdRegistersApi.md

@@ -0,0 +1,313 @@
+# PharmaObservatory::RwdRegistersApi
+
+All URIs are relative to *https://pharmaobservatory.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**rwd_registers_get**](RwdRegistersApi.md#rwd_registers_get) | **GET** /api/v1/rwd_registers/{id} | One real-world data register |
+| [**rwd_registers_list**](RwdRegistersApi.md#rwd_registers_list) | **GET** /api/v1/rwd_registers | List real-world data registers |
+| [**rwd_registers_rwd_coverage**](RwdRegistersApi.md#rwd_registers_rwd_coverage) | **GET** /api/v1/rwd_registers/{id}/rwd_coverage | HMA-EMA catalogue denominator chains |
+| [**rwd_registers_rwd_withheld_fields**](RwdRegistersApi.md#rwd_registers_rwd_withheld_fields) | **GET** /api/v1/rwd_registers/{id}/rwd_withheld_fields | HMA-EMA catalogue columns withheld from publication |
+
+
+## rwd_registers_get
+
+> <RwdRegistersRecord> rwd_registers_get(id)
+
+One real-world data register
+
+### 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::RwdRegistersApi.new
+id = 'study' # String | 
+
+begin
+  # One real-world data register
+  result = api_instance.rwd_registers_get(id)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling RwdRegistersApi->rwd_registers_get: #{e}"
+end
+```
+
+#### Using the rwd_registers_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RwdRegistersRecord>, Integer, Hash)> rwd_registers_get_with_http_info(id)
+
+```ruby
+begin
+  # One real-world data register
+  data, status_code, headers = api_instance.rwd_registers_get_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RwdRegistersRecord>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling RwdRegistersApi->rwd_registers_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**RwdRegistersRecord**](RwdRegistersRecord.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## rwd_registers_list
+
+> <RwdRegisterProvenanceResponse> rwd_registers_list(opts)
+
+List real-world data registers
+
+### 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::RwdRegistersApi.new
+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
+  # List real-world data registers
+  result = api_instance.rwd_registers_list(opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling RwdRegistersApi->rwd_registers_list: #{e}"
+end
+```
+
+#### Using the rwd_registers_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RwdRegisterProvenanceResponse>, Integer, Hash)> rwd_registers_list_with_http_info(opts)
+
+```ruby
+begin
+  # List real-world data registers
+  data, status_code, headers = api_instance.rwd_registers_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RwdRegisterProvenanceResponse>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling RwdRegistersApi->rwd_registers_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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
+
+[**RwdRegisterProvenanceResponse**](RwdRegisterProvenanceResponse.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## rwd_registers_rwd_coverage
+
+> <RwdCoverageResponse> rwd_registers_rwd_coverage(id, opts)
+
+HMA-EMA catalogue denominator chains
+
+### 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::RwdRegistersApi.new
+id = 'study' # 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
+  # HMA-EMA catalogue denominator chains
+  result = api_instance.rwd_registers_rwd_coverage(id, opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling RwdRegistersApi->rwd_registers_rwd_coverage: #{e}"
+end
+```
+
+#### Using the rwd_registers_rwd_coverage_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RwdCoverageResponse>, Integer, Hash)> rwd_registers_rwd_coverage_with_http_info(id, opts)
+
+```ruby
+begin
+  # HMA-EMA catalogue denominator chains
+  data, status_code, headers = api_instance.rwd_registers_rwd_coverage_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RwdCoverageResponse>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling RwdRegistersApi->rwd_registers_rwd_coverage_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
+
+[**RwdCoverageResponse**](RwdCoverageResponse.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## rwd_registers_rwd_withheld_fields
+
+> <RwdWithheldFieldsResponse> rwd_registers_rwd_withheld_fields(id, opts)
+
+HMA-EMA catalogue columns withheld from publication
+
+### 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::RwdRegistersApi.new
+id = 'study' # 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
+  # HMA-EMA catalogue columns withheld from publication
+  result = api_instance.rwd_registers_rwd_withheld_fields(id, opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling RwdRegistersApi->rwd_registers_rwd_withheld_fields: #{e}"
+end
+```
+
+#### Using the rwd_registers_rwd_withheld_fields_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RwdWithheldFieldsResponse>, Integer, Hash)> rwd_registers_rwd_withheld_fields_with_http_info(id, opts)
+
+```ruby
+begin
+  # HMA-EMA catalogue columns withheld from publication
+  data, status_code, headers = api_instance.rwd_registers_rwd_withheld_fields_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RwdWithheldFieldsResponse>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling RwdRegistersApi->rwd_registers_rwd_withheld_fields_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
+
+[**RwdWithheldFieldsResponse**](RwdWithheldFieldsResponse.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/RwdRegistersRecord.md

@@ -0,0 +1,38 @@
+# PharmaObservatory::RwdRegistersRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object_type** | **String** |  |  |
+| **id** | **String** |  |  |
+| **record** | [**RwdRegisterProvenanceRow**](RwdRegisterProvenanceRow.md) |  |  |
+| **attributes** | **Object** |  | [optional] |
+| **datasets** | [**Array<DatasetListing>**](DatasetListing.md) |  |  |
+| **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) |  | [optional] |
+| **source_credit** | **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::RwdRegistersRecord.new(
+  object_type: null,
+  id: null,
+  record: null,
+  attributes: null,
+  datasets: null,
+  attribution: null,
+  source_credit: null,
+  freshness: null,
+  build: null,
+  build_state: null,
+  restriction: null
+)
+```
+

data/docs/RwdSourceAgeBandsResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::RwdSourceAgeBandsResponse
+
+## 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<RwdSourceAgeBandsRow>**](RwdSourceAgeBandsRow.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::RwdSourceAgeBandsResponse.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/RwdSourceAgeBandsRow.md

@@ -0,0 +1,40 @@
+# PharmaObservatory::RwdSourceAgeBandsRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data_source_id** | **String** | The register Data source ID. The entry key of the rwd_sources object type. On a row built from a study's data source name it is null unless the name reaches exactly one registered source (see data_source_ids). | [optional] |
+| **band_ordinal** | **Integer** | The position of the age band in the source's declared list, from 1. | [optional] |
+| **age_band** | **String** | The age band label as the holder declared it. Bands can overlap (see is_nested_scheme); never sum them. | [optional] |
+| **population_size** | **Integer** | The population size the holder declared for the source (all registered persons). | [optional] |
+| **active_population_size** | **Integer** | The active population size the holder declared for the source. | [optional] |
+| **has_population_breakdown** | **Boolean** | Whether the holder published a population size breakdown by age band at all. | [optional] |
+| **has_active_population_breakdown** | **Boolean** | Whether the holder published an active population breakdown by age band at all. | [optional] |
+| **is_nested_scheme** | **Boolean** | True when the source's bands overlap, so a sum over bands double counts. | [optional] |
+| **snapshot_label** | **String** | The label of the catalogue snapshot the row was read from (a date). | [optional] |
+| **accessed_month** | **String** | The month and year the catalogue was accessed (YYYY-MM), which EMA's site asks to be cited with its URL. | [optional] |
+| **restriction_tier** | **String** | The license restriction tier of the row's source. Every row of this dataset is licensable (PROVISIONAL, legal read pending). | [optional] |
+| **attribution** | **String** | The attribution line EMA requires, including the catalogue URL and the access month; quote it with any figure taken from the row. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::RwdSourceAgeBandsRow.new(
+  data_source_id: null,
+  band_ordinal: null,
+  age_band: null,
+  population_size: null,
+  active_population_size: null,
+  has_population_breakdown: null,
+  has_active_population_breakdown: null,
+  is_nested_scheme: null,
+  snapshot_label: null,
+  accessed_month: null,
+  restriction_tier: null,
+  attribution: null
+)
+```
+

data/docs/RwdSourceConditionsResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::RwdSourceConditionsResponse
+
+## 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<RwdSourceConditionsRow>**](RwdSourceConditionsRow.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::RwdSourceConditionsResponse.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/RwdSourceConditionsRow.md

@@ -0,0 +1,68 @@
+# PharmaObservatory::RwdSourceConditionsRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data_source_id** | **String** | The register Data source ID. The entry key of the rwd_sources object type. On a row built from a study's data source name it is null unless the name reaches exactly one registered source (see data_source_ids). | [optional] |
+| **data_source_name_key** | **String** | The normalised name key the study register is joined to the data source on (the study register carries no data source id). | [optional] |
+| **condition_id** | **String** | The condition's MeSH descriptor id (D followed by six to nine digits), the id of the conditions object type. | [optional] |
+| **condition_label** | **String** | The condition's MeSH heading. | [optional] |
+| **mesh_tree_category** | **String** | The MeSH tree category the condition sits under. | [optional] |
+| **mesh_tree_prefix** | **String** | The MeSH tree prefix of that category. | [optional] |
+| **is_disease_descriptor** | **Boolean** | Whether the MeSH descriptor is a disease descriptor. | [optional] |
+| **ema_condition_terms** | **Array<String>** | The register's own condition terms that resolved to this MeSH descriptor. | [optional] |
+| **ema_condition_term_count** | **Integer** | The number of register condition terms behind the row. | [optional] |
+| **study_count** | **Integer** | How many registered studies named this source. A registered study NAMED the source; it is never evidence that the source holds data on a condition. Read it with study_register_total and studies_naming_a_registered_source, because a zero is not a finding that the source is unused. | [optional] |
+| **linked_study_ids** | **Array<String>** | The ids of the registered studies behind the row (studies of this condition that named this source). | [optional] |
+| **source_study_count** | **Integer** | How many registered studies named this source, whatever their condition: the denominator under study_count on this row. | [optional] |
+| **source_condition_study_count** | **Integer** | How many distinct registered studies of this source carry any MeSH-resolved condition, whatever the condition. | [optional] |
+| **source_condition_count** | **Integer** | How many distinct conditions have a row for this source. | [optional] |
+| **register_source_count** | **Integer** | The number of data sources in the whole data source register at the snapshot: the denominator every source count is over. Not a count of real-world data sources in the world. | [optional] |
+| **sources_with_any_study_link** | **Integer** | How many registered sources are named by at least one registered study. | [optional] |
+| **sources_with_any_condition_link** | **Integer** | How many registered sources have at least one condition row (named by a study with a resolved condition). | [optional] |
+| **study_register_total** | **Integer** | The number of studies in the whole study register at the snapshot. | [optional] |
+| **studies_naming_a_registered_source** | **Integer** | How many registered studies name at least one data source that is itself registered; the denominator under study_count. | [optional] |
+| **condition_term_total** | **Integer** | How many distinct condition terms the study register holds. | [optional] |
+| **condition_term_resolved** | **Integer** | How many of those terms resolved to a MeSH descriptor. | [optional] |
+| **linked_condition_count** | **Integer** | How many distinct MeSH conditions appear on any row of the dataset. | [optional] |
+| **snapshot_label** | **String** | The label of the catalogue snapshot the row was read from (a date). | [optional] |
+| **accessed_month** | **String** | The month and year the catalogue was accessed (YYYY-MM), which EMA's site asks to be cited with its URL. | [optional] |
+| **restriction_tier** | **String** | The license restriction tier of the row's source. Every row of this dataset is licensable (PROVISIONAL, legal read pending). | [optional] |
+| **attribution** | **String** | The attribution line EMA requires, including the catalogue URL and the access month; quote it with any figure taken from the row. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::RwdSourceConditionsRow.new(
+  data_source_id: null,
+  data_source_name_key: null,
+  condition_id: null,
+  condition_label: null,
+  mesh_tree_category: null,
+  mesh_tree_prefix: null,
+  is_disease_descriptor: null,
+  ema_condition_terms: null,
+  ema_condition_term_count: null,
+  study_count: null,
+  linked_study_ids: null,
+  source_study_count: null,
+  source_condition_study_count: null,
+  source_condition_count: null,
+  register_source_count: null,
+  sources_with_any_study_link: null,
+  sources_with_any_condition_link: null,
+  study_register_total: null,
+  studies_naming_a_registered_source: null,
+  condition_term_total: null,
+  condition_term_resolved: null,
+  linked_condition_count: null,
+  snapshot_label: null,
+  accessed_month: null,
+  restriction_tier: null,
+  attribution: null
+)
+```
+

data/docs/RwdSourceEtlMappingsResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::RwdSourceEtlMappingsResponse
+
+## 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<RwdSourceEtlMappingsRow>**](RwdSourceEtlMappingsRow.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::RwdSourceEtlMappingsResponse.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/RwdSourceEtlMappingsRow.md

@@ -0,0 +1,44 @@
+# PharmaObservatory::RwdSourceEtlMappingsRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data_source_id** | **String** | The register Data source ID. The entry key of the rwd_sources object type. On a row built from a study's data source name it is null unless the name reaches exactly one registered source (see data_source_ids). | [optional] |
+| **mapping_ordinal** | **Integer** | The position of the mapping among the source's declared CDM mappings, from 1. | [optional] |
+| **declared_mapping_count** | **Integer** | How many CDM mappings the holder declared, after register join artefacts are removed; 0 when the question was never answered. | [optional] |
+| **etl_status** | **String** | The extract-transform-load (ETL) status of the CDM mapping as typed; one comma-joined answer per declared mapping (rwd_source_etl_mappings has one row per mapping). | [optional] |
+| **etl_status_aligned** | **Boolean** | False when the register list for this column splits into a different number of pieces than the number of mappings declared; the row value is then null and the whole answer is in etl_status_source. | [optional] |
+| **etl_status_source** | **String** | The whole answer the ETL status was split from. | [optional] |
+| **etl_cdm_version** | **String** | The CDM version(s) declared for the ETL, comma-joined as typed. | [optional] |
+| **etl_cdm_version_aligned** | **Boolean** | False when the register list for this column splits into a different number of pieces than the number of mappings declared; the row value is then null and the whole answer is in etl_cdm_version_source. | [optional] |
+| **etl_cdm_version_source** | **String** | The whole answer the CDM version was split from. | [optional] |
+| **etl_frequency** | **String** | The ETL frequency declared, comma-joined as typed. | [optional] |
+| **etl_frequency_aligned** | **Boolean** | False when the register list for this column splits into a different number of pieces than the number of mappings declared; the row value is then null and the whole answer is in etl_frequency_source. | [optional] |
+| **etl_frequency_source** | **String** | The whole answer the ETL frequency was split from. | [optional] |
+| **restriction_tier** | **String** | The license restriction tier of the row's source. Every row of this dataset is licensable (PROVISIONAL, legal read pending). | [optional] |
+| **attribution** | **String** | The attribution line EMA requires, including the catalogue URL and the access month; quote it with any figure taken from the row. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::RwdSourceEtlMappingsRow.new(
+  data_source_id: null,
+  mapping_ordinal: null,
+  declared_mapping_count: null,
+  etl_status: null,
+  etl_status_aligned: null,
+  etl_status_source: null,
+  etl_cdm_version: null,
+  etl_cdm_version_aligned: null,
+  etl_cdm_version_source: null,
+  etl_frequency: null,
+  etl_frequency_aligned: null,
+  etl_frequency_source: null,
+  restriction_tier: null,
+  attribution: null
+)
+```
+