pharmaobservatory 0.1.3 → 0.1.4

data/docs/ConditionsRecord.md

@@ -0,0 +1,38 @@
+# PharmaObservatory::ConditionsRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object_type** | **String** |  |  |
+| **id** | **String** |  |  |
+| **record** | [**ConditionsRow**](ConditionsRow.md) |  |  |
+| **attributes** | [**ConditionsRecordAttributes**](ConditionsRecordAttributes.md) |  | [optional] |
+| **datasets** | [**Array<DatasetListing>**](DatasetListing.md) |  |  |
+| **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) |  | [optional] |
+| **source_credit** | **String** |  | [optional] |
+| **freshness** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ConditionsRecord.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/ConditionsRecordAttributes.md

@@ -0,0 +1,20 @@
+# PharmaObservatory::ConditionsRecordAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **condition_burden** | [**ConditionBurdenRow**](ConditionBurdenRow.md) |  | [optional] |
+| **condition_delivery** | [**ConditionDeliveryRow**](ConditionDeliveryRow.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ConditionsRecordAttributes.new(
+  condition_burden: null,
+  condition_delivery: null
+)
+```
+

data/docs/ConditionsResponse.md

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

@@ -0,0 +1,32 @@
+# PharmaObservatory::ConditionsRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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 MeSH heading. | [optional] |
+| **primary_category** | **String** | The condition's primary MeSH disease category. | [optional] |
+| **categories** | **Array<String>** | The MeSH tree branches the condition sits under (C and F03 codes). | [optional] |
+| **is_neoplasm** | **Boolean** | True when the condition sits under the MeSH neoplasms branch (C04). | [optional] |
+| **tree_numbers** | **Array<String>** | The condition's MeSH tree numbers. | [optional] |
+| **n_trials** | **Integer** | Trials tagged with the condition or with a condition beneath it in the MeSH tree. | [optional] |
+| **n_direct_trials** | **Integer** | Trials tagged with the condition itself. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ConditionsRow.new(
+  condition_id: null,
+  condition_name: null,
+  primary_category: null,
+  categories: null,
+  is_neoplasm: null,
+  tree_numbers: null,
+  n_trials: null,
+  n_direct_trials: null
+)
+```
+

data/docs/DrugPatentCliffRow.md

@@ -7,7 +7,7 @@
 | **drug_id** | **String** | The drug key. | [optional] |
 | **drug_name** | **String** | The drug's name. | [optional] |
 | **pharm_class** | **String** | The drug's pharmacologic class. | [optional] |
-| **atc_class** | **String** | The drug's ATC class. | [optional] |
+| **atc_class** | **String** | The drug's Anatomical Therapeutic Chemical (ATC) class. | [optional] |
 | **brand** | **String** | The brand name. | [optional] |
 | **candidate_brands** | **String** | Other candidate brand names, comma separated. | [optional] |
 | **cliff_date** | **Date** | The date exclusivity is expected to end (loss of exclusivity); always in the future when the dataset is built. | [optional] |

data/docs/InstitutionalHoldingsRow.md

@@ -11,8 +11,9 @@
 | **issuer_company_name** | **String** | Display name of the issuer's company. | [optional] |
 | **issuer_group_id** | **String** | Group level: the issuer's current ultimate parent; a root's group is itself. | [optional] |
 | **issuer_group_name** | **String** | Display name of the issuer's group. | [optional] |
-| **security_ref** | **String** | The security's CUSIP reference. | [optional] |
+| **security_ref** | **String** | The security's CUSIP (Committee on Uniform Securities Identification Procedures) identifier. | [optional] |
 | **holder_name** | **String** | The institutional manager's name. | [optional] |
+| **holder_identity_key** | **String** | The institutional manager's stable identity (an SEC registration number), the key that groups all of one manager's holdings. | [optional] |
 | **holder_kind** | **String** | Manager kind. | [optional] |
 | **holder_org_id** | **String** | Legal-entity level: the manager's organization record (null when unresolved). | [optional] |
 | **holder_company_id** | **String** | Company level: the manager's company (null when unresolved). | [optional] |
@@ -44,6 +45,7 @@ instance = PharmaObservatory::InstitutionalHoldingsRow.new(
   issuer_group_name: null,
   security_ref: null,
   holder_name: null,
+  holder_identity_key: null,
   holder_kind: null,
   holder_org_id: null,
   holder_company_id: null,

data/docs/LegalEntitiesApi.md

@@ -4,11 +4,13 @@ All URIs are relative to *https://pharmaobservatory.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**legal_entities_company_assets**](LegalEntitiesApi.md#legal_entities_company_assets) | **GET** /api/v1/legal_entities/{id}/company_assets | Company assets (approved and marketed drugs) |
 | [**legal_entities_company_programs**](LegalEntitiesApi.md#legal_entities_company_programs) | **GET** /api/v1/legal_entities/{id}/company_programs | Company programs |
 | [**legal_entities_drug_patent_cliff**](LegalEntitiesApi.md#legal_entities_drug_patent_cliff) | **GET** /api/v1/legal_entities/{id}/drug_patent_cliff | Patent-cliff exposure |
 | [**legal_entities_get**](LegalEntitiesApi.md#legal_entities_get) | **GET** /api/v1/legal_entities/{id} | One legal entity |
 | [**legal_entities_institutional_holdings**](LegalEntitiesApi.md#legal_entities_institutional_holdings) | **GET** /api/v1/legal_entities/{id}/institutional_holdings | Institutional holdings (SEC Form 13F) |
 | [**legal_entities_list**](LegalEntitiesApi.md#legal_entities_list) | **GET** /api/v1/legal_entities | List legal entities |
+| [**legal_entities_ownership_positions**](LegalEntitiesApi.md#legal_entities_ownership_positions) | **GET** /api/v1/legal_entities/{id}/ownership_positions | Ownership and control positions |
 | [**legal_entities_pdufa_dates**](LegalEntitiesApi.md#legal_entities_pdufa_dates) | **GET** /api/v1/legal_entities/{id}/pdufa_dates | FDA decision dates (PDUFA) and catalysts |
 | [**legal_entities_sponsor_recruitment_by_phase**](LegalEntitiesApi.md#legal_entities_sponsor_recruitment_by_phase) | **GET** /api/v1/legal_entities/{id}/sponsor_recruitment_by_phase | Trial recruitment duration by sponsor and phase |
 | [**legal_entities_sponsor_recruitment_duration**](LegalEntitiesApi.md#legal_entities_sponsor_recruitment_duration) | **GET** /api/v1/legal_entities/{id}/sponsor_recruitment_duration | Trial recruitment duration by sponsor |
@@ -16,6 +18,85 @@ All URIs are relative to *https://pharmaobservatory.com*
 | [**legal_entities_sponsor_trials**](LegalEntitiesApi.md#legal_entities_sponsor_trials) | **GET** /api/v1/legal_entities/{id}/sponsor_trials | Sponsor trials |
 
 
+## legal_entities_company_assets
+
+> <CompanyAssetsResponse> legal_entities_company_assets(id, opts)
+
+Company assets (approved and marketed drugs)
+
+### 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::LegalEntitiesApi.new
+id = 'edgar:0001114448' # 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
+  # Company assets (approved and marketed drugs)
+  result = api_instance.legal_entities_company_assets(id, opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling LegalEntitiesApi->legal_entities_company_assets: #{e}"
+end
+```
+
+#### Using the legal_entities_company_assets_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CompanyAssetsResponse>, Integer, Hash)> legal_entities_company_assets_with_http_info(id, opts)
+
+```ruby
+begin
+  # Company assets (approved and marketed drugs)
+  data, status_code, headers = api_instance.legal_entities_company_assets_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CompanyAssetsResponse>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling LegalEntitiesApi->legal_entities_company_assets_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
+
+[**CompanyAssetsResponse**](CompanyAssetsResponse.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## legal_entities_company_programs
 
 > <CompanyProgramsResponse> legal_entities_company_programs(id, opts)
@@ -397,6 +478,85 @@ end
 - **Accept**: application/json
 
 
+## legal_entities_ownership_positions
+
+> <OwnershipPositionsResponse> legal_entities_ownership_positions(id, opts)
+
+Ownership and control positions
+
+### 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::LegalEntitiesApi.new
+id = 'edgar:0001114448' # 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
+  # Ownership and control positions
+  result = api_instance.legal_entities_ownership_positions(id, opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling LegalEntitiesApi->legal_entities_ownership_positions: #{e}"
+end
+```
+
+#### Using the legal_entities_ownership_positions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OwnershipPositionsResponse>, Integer, Hash)> legal_entities_ownership_positions_with_http_info(id, opts)
+
+```ruby
+begin
+  # Ownership and control positions
+  data, status_code, headers = api_instance.legal_entities_ownership_positions_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OwnershipPositionsResponse>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling LegalEntitiesApi->legal_entities_ownership_positions_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
+
+[**OwnershipPositionsResponse**](OwnershipPositionsResponse.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## legal_entities_pdufa_dates
 
 > <PdufaDatesResponse> legal_entities_pdufa_dates(id, opts)

data/docs/LegalEntitiesRow.md

@@ -10,7 +10,7 @@
 | **org_origin** | **String** | How the organization record was minted. | [optional] |
 | **country** | **String** | Country as the source states it. | [optional] |
 | **org_type** | **String** | Organization type. | [optional] |
-| **edgar_cik** | **String** | SEC EDGAR central index key, when it files. | [optional] |
+| **edgar_cik** | **String** | Central index key (CIK) in EDGAR, the US Securities and Exchange Commission (SEC) filing system, when it files. | [optional] |
 | **edgar_ticker** | **String** | Exchange ticker, when listed. | [optional] |
 | **ror_id** | **String** | Research Organization Registry id, when it has one. | [optional] |
 | **lei** | **String** | Legal Entity Identifier, when it has one. | [optional] |

data/docs/OwnershipPositionsResponse.md

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

@@ -0,0 +1,100 @@
+# PharmaObservatory::OwnershipPositionsRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **position_id** | **String** | The position id. For a position whose owner name is withheld it is an opaque handle that derives nothing from the owner and is stable only while the other positions of the same owned company, filing family and dimension are unchanged. | [optional] |
+| **source_class** | **String** | The filing family: sec_forms_3_4_5 (insiders), sec_schedules_13d_g (beneficial owners), sec_form_adv (investment adviser control persons) or sec_def_14a (proxy-statement tables). | [optional] |
+| **ownership_dimension** | **String** | What the position measures: insider_reporting, beneficial_ownership, voting_power, economic_interest or control. Positions of different dimensions are different measurements and are not added. | [optional] |
+| **relationship_type** | **String** | The owner's relationship to the company as the filing family states it. | [optional] |
+| **subject_name** | **String** | The owned company as filed. | [optional] |
+| **subject_org_id** | **String** | Legal-entity level: the owned company's organization record. | [optional] |
+| **subject_company_id** | **String** | Company level: the owned company (null when unresolved). | [optional] |
+| **subject_company_name** | **String** | Display name of the owned company. | [optional] |
+| **subject_group_id** | **String** | Group level: the owned company's current ultimate parent; a root's group is itself. | [optional] |
+| **subject_group_name** | **String** | Display name of the owned company's group. | [optional] |
+| **owner_name** | **String** | The owner's name as filed. Null for an owner whose filing does not mark the name public (see owner_name_is_public). | [optional] |
+| **owner_name_is_public** | **Boolean** | True when the filing marks the owner's name public. When false every column that could identify the owner is null (name, identity key, person id, investor id, organization and company columns, source_url and the dates); the position and its figures stay. | [optional] |
+| **owner_kind** | **String** | What the owner is: organization, natural_person, reporting_group or unknown. | [optional] |
+| **owner_identity_key** | **String** | The owner's stable identity (an SEC registration number or an adviser registration number); null when the name is withheld. | [optional] |
+| **owner_person_id** | **String** | The key of an owner who is a natural person; null for other owners and when the name is withheld. | [optional] |
+| **owner_investor_id** | **String** | The key of the owner in the investor directory when it is one; null when the name is withheld. | [optional] |
+| **owner_org_id** | **String** | Legal-entity level: the owner's organization record (null when the owner is not an organization, is unresolved or is withheld). | [optional] |
+| **owner_company_id** | **String** | Company level: the owner's company (null when unresolved or when the name is withheld). | [optional] |
+| **owner_company_name** | **String** | Display name of the owner's company. | [optional] |
+| **owner_group_id** | **String** | Group level: the owner's current ultimate parent; a root's group is itself (null when the owner is withheld). | [optional] |
+| **owner_group_name** | **String** | Display name of the owner's group. | [optional] |
+| **shares_basis** | **String** | How the share figure was reached: sum_standing_balances (insider balances), group_reported_maximum (a joint filing's maximum, never a sum of its filers) or no_quantity (the source gives none). Read a share figure with its basis. | [optional] |
+| **shares** | **Float** | Shares the owner holds, on the shares_basis. Null when the source gives no quantity. | [optional] |
+| **shares_direct** | **Float** | Of those shares, the part held directly. | [optional] |
+| **shares_indirect** | **Float** | Of those shares, the part held indirectly. | [optional] |
+| **derivative_underlying_shares** | **Float** | Shares underlying derivative positions such as options, reported apart and never added to shares. | [optional] |
+| **percent_basis** | **String** | How the percentage was reached, for example single_reporting_person, uniform_group_percent or single_band. | [optional] |
+| **reported_percent** | **Float** | The percentage the filing reports, on the percentage_basis. | [optional] |
+| **reported_percent_low** | **Float** | The low end of a reported band, for a source that reports a band. | [optional] |
+| **reported_percent_high** | **Float** | The high end of a reported band, for a source that reports a band. | [optional] |
+| **percentage_basis** | **String** | What the percentage is of: beneficial_ownership, voting_power or economic_interest. Percentages of different bases are not comparable. | [optional] |
+| **edge_state** | **String** | standing, ceased or no_longer_reported, for the owner's position as a whole. | [optional] |
+| **position_count** | **Integer** | Positions the row consolidates. | [optional] |
+| **standing_position_count** | **Integer** | Of those, positions still standing. | [optional] |
+| **ceased_position_count** | **Integer** | Of those, positions reported ceased. | [optional] |
+| **no_longer_reported_position_count** | **Integer** | Of those, positions the filer no longer reports. | [optional] |
+| **first_observed_date** | **Date** | Date the position was first reported; null when the owner's name is withheld. | [optional] |
+| **last_activity_date** | **Date** | Date of the latest reported activity; null when the owner's name is withheld. | [optional] |
+| **last_filing_date** | **Date** | Date of the latest filing; null when the owner's name is withheld. | [optional] |
+| **source_url** | **String** | A link to the latest filing; null when the owner's name is withheld, because the filing names the owner. | [optional] |
+| **contains_personal_data** | **Boolean** | True when the row names a natural person. | [optional] |
+| **privacy_status** | **String** | The filing's privacy status for the owner: not_applicable, pending_review, approved_public_fields, restricted or protected. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::OwnershipPositionsRow.new(
+  position_id: null,
+  source_class: null,
+  ownership_dimension: null,
+  relationship_type: null,
+  subject_name: null,
+  subject_org_id: null,
+  subject_company_id: null,
+  subject_company_name: null,
+  subject_group_id: null,
+  subject_group_name: null,
+  owner_name: null,
+  owner_name_is_public: null,
+  owner_kind: null,
+  owner_identity_key: null,
+  owner_person_id: null,
+  owner_investor_id: null,
+  owner_org_id: null,
+  owner_company_id: null,
+  owner_company_name: null,
+  owner_group_id: null,
+  owner_group_name: null,
+  shares_basis: null,
+  shares: null,
+  shares_direct: null,
+  shares_indirect: null,
+  derivative_underlying_shares: null,
+  percent_basis: null,
+  reported_percent: null,
+  reported_percent_low: null,
+  reported_percent_high: null,
+  percentage_basis: null,
+  edge_state: null,
+  position_count: null,
+  standing_position_count: null,
+  ceased_position_count: null,
+  no_longer_reported_position_count: null,
+  first_observed_date: null,
+  last_activity_date: null,
+  last_filing_date: null,
+  source_url: null,
+  contains_personal_data: null,
+  privacy_status: null
+)
+```
+

data/docs/PdufaDatesRow.md

@@ -6,8 +6,8 @@
 | ---- | ---- | ----------- | ----- |
 | **pdufa_date_id** | **String** | The calendar entry id. | [optional] |
 | **source** | **String** | Which lane the row came from: benzinga, sec_extraction or both. | [optional] |
-| **restriction_tier** | **String** | none for a row from SEC filings; licensable for a row from the Benzinga calendar. | [optional] |
-| **decision_date** | **Date** | The FDA decision date (PDUFA is the date under the Prescription Drug User Fee Act). | [optional] |
+| **restriction_tier** | **String** | none for a row from SEC filings; licensable for a row from the Benzinga calendar (the filings are those made to the US Securities and Exchange Commission). | [optional] |
+| **decision_date** | **Date** | The decision date of the US Food and Drug Administration (FDA); a PDUFA date is the goal date under the Prescription Drug User Fee Act. | [optional] |
 | **date_start** | **Date** | Start of the date interval the source states. | [optional] |
 | **date_end** | **Date** | End of the date interval the source states. | [optional] |
 | **date_precision** | **String** | Precision of the date (day, month, quarter). | [optional] |

data/docs/SiteCroTrialsRow.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **site_id** | **String** | The site key: one facility spelling from the registry. | [optional] |
-| **trial_id** | **String** | The trial's registry id (NCT number). | [optional] |
+| **trial_id** | **String** | The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number). | [optional] |
 | **cro_org_id** | **String** | Legal-entity level: the CRO's organization record. | [optional] |
 | **cro_name** | **String** | The CRO organization's name. | [optional] |
 | **cro_company_id** | **String** | Company level: the company the CRO belongs to (null when unresolved). | [optional] |

data/docs/SiteTrialConditionsRow.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **site_id** | **String** | The site key: one facility spelling from the registry. | [optional] |
-| **trial_id** | **String** | The trial's registry id (NCT number). | [optional] |
+| **trial_id** | **String** | The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number). | [optional] |
 | **condition_id** | **String** | The condition key (a MeSH, Medical Subject Headings, descriptor id). | [optional] |
 | **condition_name** | **String** | The condition's name. | [optional] |
 | **overall_status** | **String** | The registry's overall status of the trial. | [optional] |

data/docs/SiteTrialDrugsRow.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **site_id** | **String** | The site key: one facility spelling from the registry. | [optional] |
-| **trial_id** | **String** | The trial's registry id (NCT number). | [optional] |
+| **trial_id** | **String** | The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number). | [optional] |
 | **drug_id** | **String** | The drug key. | [optional] |
 | **drug_name** | **String** | The drug's name. | [optional] |
 | **overall_status** | **String** | The registry's overall status of the trial. | [optional] |

data/docs/SiteTrialsRow.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **site_id** | **String** | The site key: one facility spelling from the registry. | [optional] |
-| **trial_id** | **String** | The trial's registry id (NCT number). | [optional] |
+| **trial_id** | **String** | The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number). | [optional] |
 | **trial_title** | **String** | The trial's brief title. | [optional] |
 | **study_type** | **String** | INTERVENTIONAL or OBSERVATIONAL. | [optional] |
 | **phase** | **String** | The trial phase label. | [optional] |

data/docs/SponsorRecruitmentByPhaseRow.md

@@ -19,8 +19,8 @@
 | **n_realized** | **Integer** | Per phase bucket, the same count as the series column of that name. | [optional] |
 | **realized_months_median** | **Float** | Median over the bucket's rows; NULL under min_n. | [optional] |
 | **error_phase_mae_months** | **Float** | Backtest mean absolute error in months for this phase bucket; NULL on an unmeasured bucket or one with no open predicted trial. | [optional] |
-| **error_phase_relmae_vs_baseline** | **Float** | The model MAE over the baseline MAE in this phase bucket. | [optional] |
-| **error_phase_baseline_mae_months** | **Float** | The baseline MAE in months in this phase bucket. | [optional] |
+| **error_phase_relmae_vs_baseline** | **Float** | The model's mean absolute error (MAE) over the baseline's MAE in this phase bucket. | [optional] |
+| **error_phase_baseline_mae_months** | **Float** | The baseline's mean absolute error (MAE) in months in this phase bucket. | [optional] |
 | **error_phase_n_trials** | **Integer** | Backtest trials behind the phase figure. | [optional] |
 | **error_phase_n_years** | **Integer** | Backtest years behind the phase figure. | [optional] |
 | **min_n** | **Integer** | The floor applied: a median is withheld below this many trials, carried so a reader sees the floor used. | [optional] |

data/docs/SponsorRecruitmentDurationRow.md

@@ -21,7 +21,7 @@
 | **n_start_not_actual** | **Integer** | Evaluated trials with prediction_status start_not_actual. | [optional] |
 | **n_fit_failed** | **Integer** | Evaluated trials with prediction_status fit_failed. | [optional] |
 | **n_predicted** | **Integer** | Evaluated trials with prediction_status predicted, superseded or not. | [optional] |
-| **n_predicted_superseded** | **Integer** | Predicted trials whose CURRENT record shows the outcome (COMPLETED, TERMINATED, WITHDRAWN or an ACTUAL primary completion); kept out of every predicted figure, as the trial page withholds them. | [optional] |
+| **n_predicted_superseded** | **Integer** | Predicted trials whose CURRENT record shows the outcome (COMPLETED, TERMINATED, WITHDRAWN or an ACTUAL primary completion); kept out of every predicted figure. | [optional] |
 | **n_predicted_open** | **Integer** | n_predicted - n_predicted_superseded; the denominator of every predicted figure. | [optional] |
 | **n_predicted_at_cap** | **Integer** | Open predicted trials whose figure sits at the horizon cap (an at-cap row contributes the cap to the median). | [optional] |
 | **n_predicted_overdue** | **Integer** | Open predicted trials running past their predicted end at the cutoff. | [optional] |

data/docs/SponsorTrialsRow.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **trial_id** | **String** | The trial's registry id (NCT number). | [optional] |
+| **trial_id** | **String** | The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number). | [optional] |
 | **sponsor_role** | **String** | lead or collaborator. | [optional] |
 | **sponsor_name** | **String** | The sponsor name as filed. | [optional] |
 | **sponsor_org_id** | **String** | Legal-entity level: the organization record the sponsor resolved to (null when unresolved). | [optional] |
@@ -12,7 +12,7 @@
 | **sponsor_company_name** | **String** | Display name of the sponsor's company. | [optional] |
 | **sponsor_group_id** | **String** | Group level: the sponsor's current ultimate parent company; a root company's group is itself. | [optional] |
 | **sponsor_group_name** | **String** | Display name of the sponsor's group. | [optional] |
-| **sponsor_agency_class** | **String** | The registry's agency class for the sponsor (INDUSTRY, NIH, OTHER ...). | [optional] |
+| **sponsor_agency_class** | **String** | The registry's agency class for the sponsor (INDUSTRY, NIH for the US National Institutes of Health, OTHER ...). | [optional] |
 | **sponsor_resolution_method** | **String** | How the sponsor name was resolved to an organization record. | [optional] |
 | **trial_title** | **String** | The trial's brief title. | [optional] |
 | **study_type** | **String** | INTERVENTIONAL or OBSERVATIONAL. | [optional] |