pharmaobservatory 0.1.4 → 0.1.6

data/docs/ManagersApi.md

@@ -0,0 +1,233 @@
+# PharmaObservatory::ManagersApi
+
+All URIs are relative to *https://pharmaobservatory.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**managers_get**](ManagersApi.md#managers_get) | **GET** /api/v1/managers/{id} | One form 13f manager |
+| [**managers_institutional_holdings**](ManagersApi.md#managers_institutional_holdings) | **GET** /api/v1/managers/{id}/institutional_holdings | Institutional holdings (SEC Form 13F) |
+| [**managers_list**](ManagersApi.md#managers_list) | **GET** /api/v1/managers | List form 13f managers |
+
+
+## managers_get
+
+> <ManagersRecord> managers_get(id)
+
+One form 13f manager
+
+### 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::ManagersApi.new
+id = 'edgar_cik:0002900005' # String | 
+
+begin
+  # One form 13f manager
+  result = api_instance.managers_get(id)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ManagersApi->managers_get: #{e}"
+end
+```
+
+#### Using the managers_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ManagersRecord>, Integer, Hash)> managers_get_with_http_info(id)
+
+```ruby
+begin
+  # One form 13f manager
+  data, status_code, headers = api_instance.managers_get_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ManagersRecord>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ManagersApi->managers_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**ManagersRecord**](ManagersRecord.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## managers_institutional_holdings
+
+> <InstitutionalHoldingsResponse> managers_institutional_holdings(id, opts)
+
+Institutional holdings (SEC Form 13F)
+
+### 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::ManagersApi.new
+id = 'edgar_cik:0002900005' # 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
+  # Institutional holdings (SEC Form 13F)
+  result = api_instance.managers_institutional_holdings(id, opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ManagersApi->managers_institutional_holdings: #{e}"
+end
+```
+
+#### Using the managers_institutional_holdings_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InstitutionalHoldingsResponse>, Integer, Hash)> managers_institutional_holdings_with_http_info(id, opts)
+
+```ruby
+begin
+  # Institutional holdings (SEC Form 13F)
+  data, status_code, headers = api_instance.managers_institutional_holdings_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InstitutionalHoldingsResponse>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ManagersApi->managers_institutional_holdings_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
+
+[**InstitutionalHoldingsResponse**](InstitutionalHoldingsResponse.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## managers_list
+
+> <ManagersResponse> managers_list(opts)
+
+List form 13f managers
+
+### 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::ManagersApi.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 form 13f managers
+  result = api_instance.managers_list(opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ManagersApi->managers_list: #{e}"
+end
+```
+
+#### Using the managers_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ManagersResponse>, Integer, Hash)> managers_list_with_http_info(opts)
+
+```ruby
+begin
+  # List form 13f managers
+  data, status_code, headers = api_instance.managers_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ManagersResponse>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ManagersApi->managers_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
+
+[**ManagersResponse**](ManagersResponse.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ManagersRecord.md

@@ -0,0 +1,38 @@
+# PharmaObservatory::ManagersRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object_type** | **String** |  |  |
+| **id** | **String** |  |  |
+| **record** | [**ManagersRow**](ManagersRow.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::ManagersRecord.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/ManagersResponse.md

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

@@ -0,0 +1,46 @@
+# PharmaObservatory::ManagersRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **manager_id** | **String** | The manager key, the id the web page uses: edgar_cik:<10-digit filer CIK>, or party:sec-cik:<ref> for a filer whose CIK is malformed. The same value as holder_identity_key on institutional_holdings. | [optional] |
+| **name** | **String** | The manager's name as filed (the longest variant), falling back to the manager key. | [optional] |
+| **name_variant_count** | **Integer** | How many spellings of the name the filings carry. | [optional] |
+| **investor_id** | **String** | The manager's investor key where the link resolves; null when the manager resolves to no investor or its rows disagree (see investor_link_conflict). | [optional] |
+| **investor_link_conflict** | **Boolean** | True when the manager's own holding rows resolve to different investors, so no investor is linked. | [optional] |
+| **org_id** | **String** | Legal-entity level: the manager's organization record when all its rows agree on one (null otherwise). | [optional] |
+| **company_id** | **String** | Company level: the manager's company (null when unresolved). | [optional] |
+| **company_name** | **String** | Display name of the manager's company. | [optional] |
+| **group_id** | **String** | Group level: the manager's company's current ultimate parent; a root's group is itself. | [optional] |
+| **group_name** | **String** | Display name of the manager's group. | [optional] |
+| **position_count** | **Integer** | Current positions the manager reports, one per issuer security. | [optional] |
+| **issuer_count** | **Integer** | Distinct issuer securities (CUSIPs) across those positions. | [optional] |
+| **valued_position_count** | **Integer** | Of those positions, the ones with a reported value (a position whose filing scale was ambiguous has none). | [optional] |
+| **first_observed_date** | **Date** | The earliest filing date a current position was first observed. | [optional] |
+| **last_filing_date** | **Date** | The latest filing date among the manager's positions. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ManagersRow.new(
+  manager_id: null,
+  name: null,
+  name_variant_count: null,
+  investor_id: null,
+  investor_link_conflict: null,
+  org_id: null,
+  company_id: null,
+  company_name: null,
+  group_id: null,
+  group_name: null,
+  position_count: null,
+  issuer_count: null,
+  valued_position_count: null,
+  first_observed_date: null,
+  last_filing_date: null
+)
+```
+

data/docs/OrgDisclosuresResponse.md

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

@@ -0,0 +1,56 @@
+# PharmaObservatory::OrgDisclosuresRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_id** | **String** | Legal-entity level: the organization record. | [optional] |
+| **org_name** | **String** | The organization's name. | [optional] |
+| **company_id** | **String** | Company level: the company (null when unresolved). | [optional] |
+| **company_name** | **String** | Display name of the company. | [optional] |
+| **group_id** | **String** | Group level: the current ultimate parent; a root's group is itself. | [optional] |
+| **group_name** | **String** | Display name of the group. | [optional] |
+| **claim_category** | **String** | The claim's domain: climate or diversity. | [optional] |
+| **claim_type** | **String** | Which claim the row is about. Climate: net_zero_target, near_term_target, sbti_status_claimed, target_temperature_claimed. Diversity: board_pct_women, workforce_pct_women, leadership_pct_women, workforce_pct_underrepresented, gender_pay_gap_pct, has_dei_targets, external_recognition_claimed. | [optional] |
+| **disclosure_source** | **String** | Where the claim comes from: sec_edgar_extraction (figures extracted from the company's own US Securities and Exchange Commission filings, open) or sbti (the Science Based Targets initiative dashboard, licensable). | [optional] |
+| **disclosure_state** | **String** | disclosed: the source states a value or a positive claim. true_negative: the source states a real negative (false or none). not_disclosed: the source covers this organization and states no value for the claim. A claim withheld from a caller who lacks the licence is not a state: the row is absent for that caller and the response names the withheld tier. | [optional] |
+| **claim_value** | **String** | The claimed value as text: true or false for a yes-or-no claim, a number for a percentage, the source's own word for a status. Null when disclosure_state is not_disclosed. | [optional] |
+| **claim_detail** | **String** | A qualifier of the claim, such as the target year. Null when the source gives none. | [optional] |
+| **disclosure_date** | **Date** | The date of the disclosure: the filing date for an extracted claim, the dashboard's last-updated date for an SBTi claim. Null when the source gives none. | [optional] |
+| **reporting_year** | **String** | The reporting year the company states for an extracted claim. Null for an SBTi claim. | [optional] |
+| **evidence_quote** | **String** | The sentence of the filing the figure was extracted from. Null for an SBTi claim. | [optional] |
+| **confidence** | **Float** | The extraction confidence, 0 to 1. Null for an SBTi claim, which carries none. | [optional] |
+| **source_record_id** | **String** | The source record: the filing document id for an extracted claim, the SBTi company id for an SBTi claim. | [optional] |
+| **license_name** | **String** | The licence of the claim's source. | [optional] |
+| **attribution** | **String** | The credit line for the claim's source. Show it wherever the claim is shown. | [optional] |
+| **restriction_tier** | **String** | none for an extracted claim, licensable for an SBTi claim. The view withholds a licensable row from a caller who does not hold the licence. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::OrgDisclosuresRow.new(
+  org_id: null,
+  org_name: null,
+  company_id: null,
+  company_name: null,
+  group_id: null,
+  group_name: null,
+  claim_category: null,
+  claim_type: null,
+  disclosure_source: null,
+  disclosure_state: null,
+  claim_value: null,
+  claim_detail: null,
+  disclosure_date: null,
+  reporting_year: null,
+  evidence_quote: null,
+  confidence: null,
+  source_record_id: null,
+  license_name: null,
+  attribution: null,
+  restriction_tier: null
+)
+```
+

data/docs/OrgRelationshipsResponse.md

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

@@ -0,0 +1,68 @@
+# PharmaObservatory::OrgRelationshipsRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subject_org_id** | **String** | Legal-entity level: the subject's organization record. | [optional] |
+| **subject_name** | **String** | The organization's name as filed. | [optional] |
+| **subject_company_id** | **String** | Company level: the subject's company (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; a root's group is itself. | [optional] |
+| **subject_group_name** | **String** | Display name of the subject's group. | [optional] |
+| **object_org_id** | **String** | Legal-entity level: the object's organization record. | [optional] |
+| **object_name** | **String** | The organization's name as filed. | [optional] |
+| **object_company_id** | **String** | Company level: the object's company (null when unresolved). | [optional] |
+| **object_company_name** | **String** | Display name of the object's company. | [optional] |
+| **object_group_id** | **String** | Group level: the object's current ultimate parent; a root's group is itself. | [optional] |
+| **object_group_name** | **String** | Display name of the object's group. | [optional] |
+| **predicate** | **String** | The directed relationship from subject to object: parent_of and ultimate_parent_of (corporate ownership, the subject is the parent), linked_charity_of (a charity linked to the main charity), uses_vendor (a sponsor and the contract research organization inferred for its trials), co_sponsors_trial_with (two sponsors of one trial), project_partner_of and awards_to (UK research grants). | [optional] |
+| **edge_family** | **String** | The family of the predicate: corporate_structure (parent_of, ultimate_parent_of, linked_charity_of), contract_vendor (uses_vendor), co_sponsorship (co_sponsors_trial_with) or research_funding (project_partner_of, awards_to). | [optional] |
+| **edge_scope** | **String** | general for an edge from a source that covers organizations at large (GLEIF, Charity Commission, the contract research organization (CRO) inference); rare_disease_scoped for an edge from a source read only for organizations in the rare-disease evidence set (ROR, co-sponsorship, UK research grants). A rare_disease_scoped edge is a true edge and an incomplete picture: an organization with none of them has not been shown to have none. | [optional] |
+| **source_key** | **String** | The source that asserted the edge: gleif (Global Legal Entity Identifier Foundation Golden Copy), charity_commission, aact_cro_inference (inferred from ClinicalTrials.gov filings against a curated CRO list), ror (Research Organization Registry), aact (ClinicalTrials.gov) or ukri_gtr (UK Research and Innovation Gateway to Research). | [optional] |
+| **evidence_type** | **String** | The kind of evidence behind the edge: registry (a register entry), trial, project or grant. | [optional] |
+| **authority_class** | **String** | authoritative when the source itself filed the relationship; derived when the edge is an inference (the CRO edge is a curated-list name match, not a filing). | [optional] |
+| **evidence_count** | **Integer** | The source records behind the edge. Counted within one source, so it does not add across sources. | [optional] |
+| **context_count** | **Integer** | Distinct source record contexts among them (for example distinct trials). | [optional] |
+| **confidence** | **Float** | The highest confidence among the edge's records, 0 to 1, where the source states one. Null for sources that state none. A GLEIF ownership-resolution score and a CRO name-match score are different measures; do not compare them. | [optional] |
+| **first_observed_at** | **Time** | When the earliest of the edge's records was observed in the source. | [optional] |
+| **last_observed_at** | **Time** | When the latest of the edge's records was observed in the source. | [optional] |
+| **license_name** | **String** | The licence of the source behind the edge. | [optional] |
+| **attribution** | **String** | The credit line the source requires for the edge. Show it wherever the edge is shown: the Charity Commission and UK Research and Innovation edges require it under the Open Government Licence v3.0. | [optional] |
+| **restriction_tier** | **String** | Always none: every source behind these edges is open, and a test on the source assertions reports any restricted source that is ever added. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::OrgRelationshipsRow.new(
+  subject_org_id: null,
+  subject_name: null,
+  subject_company_id: null,
+  subject_company_name: null,
+  subject_group_id: null,
+  subject_group_name: null,
+  object_org_id: null,
+  object_name: null,
+  object_company_id: null,
+  object_company_name: null,
+  object_group_id: null,
+  object_group_name: null,
+  predicate: null,
+  edge_family: null,
+  edge_scope: null,
+  source_key: null,
+  evidence_type: null,
+  authority_class: null,
+  evidence_count: null,
+  context_count: null,
+  confidence: null,
+  first_observed_at: null,
+  last_observed_at: null,
+  license_name: null,
+  attribution: null,
+  restriction_tier: null
+)
+```
+

data/docs/OwnershipPositionsResponse.md

@@ -8,7 +8,7 @@
 | **grain** | **String** |  | [optional] |
 | **object_type** | **String** |  | [optional] |
 | **id** | **String** |  | [optional] |
-| **scope** | [**BiomarkerCdxAssertionsResponseScope**](BiomarkerCdxAssertionsResponseScope.md) |  | [optional] |
+| **scope** | [**BiomarkerAssayEvidenceResponseScope**](BiomarkerAssayEvidenceResponseScope.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] |
@@ -21,8 +21,8 @@
 | **source_credit** | **String** |  | [optional] |
 | **withheld_tiers** | **Array<String>** |  | [optional] |
 | **withheld_columns** | **Array<String>** |  | [optional] |
-| **freshness** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) |  | [optional] |
-| **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.md) |  | [optional] |
+| **freshness** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.md) |  | [optional] |
 | **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
 | **restriction** | **Hash<String, Object>** |  | [optional] |