pharmaobservatory 0.1.7 → 0.1.8

data/docs/LegalEntitiesRecordAttributes.md

@@ -4,7 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **legal_entity_sec_filings** | [**LegalEntitySecFilingsRow**](LegalEntitySecFilingsRow.md) |  | [optional] |
 | **ownership_percentages** | [**OwnershipPercentagesRow**](OwnershipPercentagesRow.md) |  | [optional] |
+| **sbti_crosscheck** | [**SbtiCrosscheckRow**](SbtiCrosscheckRow.md) |  | [optional] |
+| **sponsor_delivery** | [**SponsorDeliveryRow**](SponsorDeliveryRow.md) |  | [optional] |
 | **sponsor_recruitment_duration** | [**SponsorRecruitmentDurationRow**](SponsorRecruitmentDurationRow.md) |  | [optional] |
 
 ## Example
@@ -13,7 +16,10 @@
 require 'pharmaobservatory'
 
 instance = PharmaObservatory::LegalEntitiesRecordAttributes.new(
+  legal_entity_sec_filings: null,
   ownership_percentages: null,
+  sbti_crosscheck: null,
+  sponsor_delivery: null,
   sponsor_recruitment_duration: null
 )
 ```

data/docs/LegalEntitySecFilingsResponse.md

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

@@ -0,0 +1,44 @@
+# PharmaObservatory::LegalEntitySecFilingsRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_id** | **String** | Legal-entity level: the SEC filer organization record. | [optional] |
+| **org_name** | **String** | Display name of the filer organization record. | [optional] |
+| **company_id** | **String** | Company level: the company the filer belongs to (null when unresolved). | [optional] |
+| **company_name** | **String** | Display name of the filer's company. | [optional] |
+| **group_id** | **String** | Group level: the filer's current ultimate parent company; a root company's group is itself. | [optional] |
+| **group_name** | **String** | Display name of the filer's group. | [optional] |
+| **edgar_cik** | **String** | The filer's 10-digit SEC Central Index Key (CIK). | [optional] |
+| **jurisdiction_of_inc** | **String** | The jurisdiction of incorporation as the latest filing states it (a US state or a country, free text); null when blank. | [optional] |
+| **entity_type** | **String** | The entity type the latest filing states (Corporation, Limited Liability Company, Limited Partnership, General Partnership, Business Trust or Other); null when blank. | [optional] |
+| **entity_type_other_desc** | **String** | The filer's free-text description when it ticked entity type Other. | [optional] |
+| **year_of_inc_band** | **String** | The filing's year-of-incorporation choice (Over Five Years Ago, Within Last Five Years or Yet to Be Formed); null when blank. | [optional] |
+| **year_of_inc** | **Integer** | The year of incorporation when the filing gives a four-digit year. | [optional] |
+| **industry_group_types** | **Array<String>** | The industry groups the filer's in-scope filings name. | [optional] |
+| **previous_names** | **Array<String>** | Earlier names the filer states, other than its current name. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::LegalEntitySecFilingsRow.new(
+  org_id: null,
+  org_name: null,
+  company_id: null,
+  company_name: null,
+  group_id: null,
+  group_name: null,
+  edgar_cik: null,
+  jurisdiction_of_inc: null,
+  entity_type: null,
+  entity_type_other_desc: null,
+  year_of_inc_band: null,
+  year_of_inc: null,
+  industry_group_types: null,
+  previous_names: null
+)
+```
+

data/docs/OrgDisclosureTrendResponse.md

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

@@ -0,0 +1,62 @@
+# PharmaObservatory::OrgDisclosureTrendRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_id** | **String** | Legal-entity level: the organization record of the SEC registrant that filed. | [optional] |
+| **org_name** | **String** | Display name of the filing organization record. | [optional] |
+| **company_id** | **String** | Company level: the company the filing organization belongs to (null when unresolved). | [optional] |
+| **company_name** | **String** | Display name of the filing organization's company. | [optional] |
+| **group_id** | **String** | Group level: the filing organization's current ultimate parent company; a root company's group is itself. | [optional] |
+| **group_name** | **String** | Display name of the filing organization's group. | [optional] |
+| **reporting_year** | **Integer** | The fiscal year the filing reports. | [optional] |
+| **reporting_company** | **String** | The company name as the filing states it. | [optional] |
+| **cik** | **String** | The registrant's SEC Central Index Key (CIK). | [optional] |
+| **ticker** | **String** | The stock ticker the filing states. | [optional] |
+| **board_pct_women** | **Float** | Women's share of the board, as the filing states it. | [optional] |
+| **workforce_pct_women** | **Float** | Women's share of the workforce. | [optional] |
+| **leadership_pct_women** | **Float** | Women's share of leadership roles. | [optional] |
+| **workforce_pct_underrepresented** | **Float** | Share of the workforce from underrepresented groups. | [optional] |
+| **gender_pay_gap_pct** | **Float** | The stated gender pay gap. | [optional] |
+| **has_dei_targets** | **Boolean** | Whether the filing states diversity, equity and inclusion targets. | [optional] |
+| **has_net_zero_target** | **Boolean** | Whether the filing states a net-zero target. | [optional] |
+| **net_zero_target_year** | **Integer** | The year of the net-zero target. | [optional] |
+| **reduction_pct** | **Float** | The emissions reduction the filing commits to. | [optional] |
+| **sbti_status_claimed** | **String** | The Science Based Targets initiative (SBTi) status the filing claims for itself (a claim in the filing, not the SBTi list). | [optional] |
+| **target_temperature_claimed** | **String** | The warming limit the filing says its targets align with. | [optional] |
+| **climate_document_id** | **String** | The filing document the climate measures were extracted from. | [optional] |
+| **diversity_document_id** | **String** | The filing document the diversity measures were extracted from. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::OrgDisclosureTrendRow.new(
+  org_id: null,
+  org_name: null,
+  company_id: null,
+  company_name: null,
+  group_id: null,
+  group_name: null,
+  reporting_year: null,
+  reporting_company: null,
+  cik: null,
+  ticker: null,
+  board_pct_women: null,
+  workforce_pct_women: null,
+  leadership_pct_women: null,
+  workforce_pct_underrepresented: null,
+  gender_pay_gap_pct: null,
+  has_dei_targets: null,
+  has_net_zero_target: null,
+  net_zero_target_year: null,
+  reduction_pct: null,
+  sbti_status_claimed: null,
+  target_temperature_claimed: null,
+  climate_document_id: null,
+  diversity_document_id: null
+)
+```
+

data/docs/OwnershipSourceCoverageResponse.md

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

@@ -0,0 +1,62 @@
+# PharmaObservatory::OwnershipSourceCoverageRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source_class** | **String** | The ownership source class (for example sec_def_14a for proxy statements, sec_form_adv for Form ADV). | [optional] |
+| **subject_source_ref** | **String** | The subject as the source names it: the source's own reference for the owned company. | [optional] |
+| **subject_name** | **String** | The subject's name as filed. | [optional] |
+| **subject_org_id** | **String** | Legal-entity level: the organization record of the subject. | [optional] |
+| **subject_company_id** | **String** | Company level: the company the subject belongs to (null when unresolved). | [optional] |
+| **subject_company_name** | **String** | Display name of the subject's company. | [optional] |
+| **subject_group_id** | **String** | Group level: the subject's current ultimate parent company; a root company's group is itself. | [optional] |
+| **subject_group_name** | **String** | Display name of the subject's group. | [optional] |
+| **source_system** | **String** | The system the source class is read from (for example sec_edgar). | [optional] |
+| **source_load_state** | **String** | The whole-source state: loaded, served_by_dedicated_mart (13F is served by the institutional holdings datasets), no_documents_ingested or source_not_ingested. | [optional] |
+| **source_documents_ingested** | **Integer** | Documents the whole source has ingested. | [optional] |
+| **coverage_state** | **String** | What the source read about this subject: reported, no_reportable_owner, extraction_abstained or read_no_owner. | [optional] |
+| **documents_ingested** | **Integer** | Documents the source ingested about this subject. | [optional] |
+| **observations** | **Integer** | Ownership observations the source recorded about this subject. | [optional] |
+| **current_edges** | **Integer** | Ownership relationships that currently stand. | [optional] |
+| **owners_distinct** | **Integer** | Distinct owners the source named for this subject. | [optional] |
+| **owners_unresolved** | **Integer** | Named owners that did not resolve to an organization or investor. | [optional] |
+| **no_reportable_owner_statements** | **Integer** | Filings that positively stated the subject has no reportable owner. | [optional] |
+| **extraction_abstained** | **Integer** | Documents on which the extractor abstained. | [optional] |
+| **last_filing_date** | **Date** | The latest filing date the source holds for this subject. | [optional] |
+| **max_as_of_date** | **Date** | The latest as-of date among the subject's observations. | [optional] |
+| **source_license** | **String** | The licence of the source. | [optional] |
+| **attribution** | **String** | The credit line for the source. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::OwnershipSourceCoverageRow.new(
+  source_class: null,
+  subject_source_ref: null,
+  subject_name: null,
+  subject_org_id: null,
+  subject_company_id: null,
+  subject_company_name: null,
+  subject_group_id: null,
+  subject_group_name: null,
+  source_system: null,
+  source_load_state: null,
+  source_documents_ingested: null,
+  coverage_state: null,
+  documents_ingested: null,
+  observations: null,
+  current_edges: null,
+  owners_distinct: null,
+  owners_unresolved: null,
+  no_reportable_owner_statements: null,
+  extraction_abstained: null,
+  last_filing_date: null,
+  max_as_of_date: null,
+  source_license: null,
+  attribution: null
+)
+```
+

data/docs/ProgramLicensingCandidatesRow.md

@@ -15,7 +15,9 @@
 | **condition_id** | **String** | The condition key, a MeSH (Medical Subject Headings) descriptor id (D followed by six to nine digits). | [optional] |
 | **condition_name** | **String** | The condition's name. | [optional] |
 | **condition_ancestor_ids** | **Array<String>** | Every MeSH descriptor id at or above the condition in the tree, the condition itself included. Filter a subtree with = ANY. | [optional] |
-| **max_phase** | **Integer** | Highest phase reached: 0 early phase 1 through 6 for phase 4 (marketed); -1 when unstated. | [optional] |
+| **max_phase** | **Integer** | Highest phase reached on the 0 to 4 scale: 0 not reported, 1 through 4 for phase 1 through phase 4 (4 is marketed); a split phase folds up to its higher phase. | [optional] |
+| **max_phase_label** | **String** | The furthest phase reached with the split phases kept: Early 1, Phase 1, Phase 1/2, Phase 2, Phase 2/3, Phase 3, Phase 4, or Not reported. max_phase is the same value folded onto 0 to 4 (a split phase counts as its higher phase). | [optional] |
+| **max_phase_fine_rank** | **Integer** | The finest phase rank behind max_phase_label: 6 Phase 4, 5 Phase 3, 4 Phase 2/3, 3 Phase 2, 2 Phase 1/2, 1 Phase 1, 0 Early 1, -1 not reported. Sort on it to order programs by furthest phase with the split phases kept; max_phase is the same value folded onto 0 to 4. | [optional] |
 | **n_trials** | **Integer** | Lead-sponsored trials in the program. | [optional] |
 | **n_active** | **Integer** | Of those, trials in an active status. | [optional] |
 | **last_year** | **Integer** | Latest trial start year. | [optional] |
@@ -44,6 +46,8 @@ instance = PharmaObservatory::ProgramLicensingCandidatesRow.new(
   condition_name: null,
   condition_ancestor_ids: null,
   max_phase: null,
+  max_phase_label: null,
+  max_phase_fine_rank: null,
   n_trials: null,
   n_active: null,
   last_year: null,

data/docs/ProgramsRow.md

@@ -11,7 +11,7 @@
 | **condition_id** | **String** | The condition key, a MeSH (Medical Subject Headings) descriptor id (D followed by six to nine digits). | [optional] |
 | **condition_name** | **String** | The condition's name. | [optional] |
 | **is_indication** | **Boolean** | True for a specific disease, false for a broad MeSH umbrella condition. | [optional] |
-| **max_phase** | **Integer** | Highest phase reached across the program's trials: 0 not reported, 1 through 4 for phase 1 through phase 4 (the 0 to 4 scale; see caveats). | [optional] |
+| **max_phase** | **Integer** | Highest phase reached across the program's trials: 0 not reported, 1 through 4 for phase 1 through phase 4 (the 0 to 4 scale shared with company_programs; see caveats). | [optional] |
 | **n_trials** | **Integer** | Distinct trials of the program, across all sponsors. | [optional] |
 | **n_completed** | **Integer** | Of those, trials with status completed. | [optional] |
 | **n_terminated** | **Integer** | Of those, trials with status terminated. | [optional] |

data/docs/RwdConductorDeliveryResponse.md

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

@@ -0,0 +1,74 @@
+# PharmaObservatory::RwdConductorDeliveryRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conductor_name_key** | **String** | The normalised institution name key the conductor rollup is keyed on; every register institution whose name folds to it is one conductor. | [optional] |
+| **conductor_id** | **String** | The conductor slug: the register's normalised institution name key with spaces as hyphens, the id in the web page address (/rwd-conductors/<id>). The entry key of the rwd_conductors object type; injective because no name key carries a hyphen. | [optional] |
+| **conductor_name** | **String** | The conductor's display name: one register spelling of the key. | [optional] |
+| **conductor_names** | **Array<String>** | Every register spelling of the key, as the study lists name it. | [optional] |
+| **mandate_stratum** | **String** | all (every study of the conductor), mandated (studies a regulator required) or voluntary (studies the registrant says it did not require); studies with an unknown mandate are in all only. | [optional] |
+| **register_institution_ids** | **Array<String>** | The register Institution IDs of every register row that folds to this conductor (more than one when the register lists the name twice). | [optional] |
+| **register_row_count** | **Integer** | How many register institution rows fold to this conductor; above one means the register lists the name more than once and the counts are per name, not per row. | [optional] |
+| **declared_office_countries** | **Array<String>** | The office country text the register institutions declare, one element per distinct declaration; the office is not where the conductor delivered studies (see rwd_conductor_footprint). | [optional] |
+| **any_encepp_partner** | **Boolean** | True when any register row of the conductor declares itself an ENCePP (European Network of Centres for Pharmacoepidemiology and Pharmacovigilance) partner. | [optional] |
+| **lifetime_studies** | **Integer** | Distinct registered studies the conductor is named as conducting institution on. Not additive with additional_role_studies. | [optional] |
+| **recent_studies** | **Integer** | Conducting studies that started within five years of the snapshot. | [optional] |
+| **ongoing_studies** | **Integer** | Conducting studies whose status is Ongoing. | [optional] |
+| **additional_role_studies** | **Integer** | Distinct registered studies the conductor is named on as an additional institution; a different claim from conducting, never added to it. | [optional] |
+| **mandated_studies** | **Integer** | Conducting studies a regulator required (mandate_stratum mandated). | [optional] |
+| **mandated_share** | **Float** | mandated_studies over lifetime_studies; null when the conductor has no conducting study. | [optional] |
+| **final_report_pairs** | **Integer** | Conducting studies with both a planned and an actual final report date. | [optional] |
+| **backfilled_pairs** | **Integer** | Of those pairs, the studies whose planned and actual date are equal to the day (a likely backfill). | [optional] |
+| **comparable_pairs** | **Integer** | Conducting studies with a final report slip (both dates present and different); the denominator of the delivery figures. | [optional] |
+| **backfilled_share** | **Float** | backfilled_pairs over final_report_pairs; null when there is no pair. | [optional] |
+| **n_floor** | **Integer** | The floor on comparable_pairs below which the median, quartiles and late count are null (suppressed, not zero). | [optional] |
+| **meets_n_floor** | **Boolean** | True when comparable_pairs reaches n_floor, so the slip figures are shown. | [optional] |
+| **median_slip_days** | **Float** | Median final report slip in days (positive is late) over the conductor's comparable pairs; null below the floor. | [optional] |
+| **p25_slip_days** | **Float** | First quartile of the final report slip in days; null below the floor. | [optional] |
+| **p75_slip_days** | **Float** | Third quartile of the final report slip in days; null below the floor. | [optional] |
+| **late_over_30d** | **Integer** | Comparable studies whose final report slipped more than 30 days; null below the floor. | [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::RwdConductorDeliveryRow.new(
+  conductor_name_key: null,
+  conductor_id: null,
+  conductor_name: null,
+  conductor_names: null,
+  mandate_stratum: null,
+  register_institution_ids: null,
+  register_row_count: null,
+  declared_office_countries: null,
+  any_encepp_partner: null,
+  lifetime_studies: null,
+  recent_studies: null,
+  ongoing_studies: null,
+  additional_role_studies: null,
+  mandated_studies: null,
+  mandated_share: null,
+  final_report_pairs: null,
+  backfilled_pairs: null,
+  comparable_pairs: null,
+  backfilled_share: null,
+  n_floor: null,
+  meets_n_floor: null,
+  median_slip_days: null,
+  p25_slip_days: null,
+  p75_slip_days: null,
+  late_over_30d: null,
+  snapshot_label: null,
+  accessed_month: null,
+  restriction_tier: null,
+  attribution: null
+)
+```
+

data/docs/RwdConductorFootprintResponse.md

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

@@ -0,0 +1,40 @@
+# PharmaObservatory::RwdConductorFootprintRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conductor_name_key** | **String** | The normalised institution name key the conductor rollup is keyed on; every register institution whose name folds to it is one conductor. | [optional] |
+| **conductor_id** | **String** | The conductor slug: the register's normalised institution name key with spaces as hyphens, the id in the web page address (/rwd-conductors/<id>). The entry key of the rwd_conductors object type; injective because no name key carries a hyphen. | [optional] |
+| **conductor_name** | **String** | The conductor's display name: one register spelling of the key. | [optional] |
+| **dimension** | **String** | What the footprint value is: delivered_country (a country of a conducting study) or delivered_data_source (a registered data source a conducting study names). | [optional] |
+| **value** | **String** | The country or data source name the row counts. | [optional] |
+| **study_count** | **Integer** | Distinct conducting studies of the conductor for this country or data source. | [optional] |
+| **conductor_study_count** | **Integer** | Distinct conducting studies of the conductor, the denominator beside study_count. | [optional] |
+| **data_source_ids** | **Array<String>** | The register Data source IDs of the registered sources with this name (delivered_data_source rows only; null for a country). | [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::RwdConductorFootprintRow.new(
+  conductor_name_key: null,
+  conductor_id: null,
+  conductor_name: null,
+  dimension: null,
+  value: null,
+  study_count: null,
+  conductor_study_count: null,
+  data_source_ids: null,
+  snapshot_label: null,
+  accessed_month: null,
+  restriction_tier: null,
+  attribution: null
+)
+```
+