pharmaobservatory 0.1.6 → 0.1.8

data/docs/ConditionsApi.md

@@ -19,6 +19,10 @@ All URIs are relative to *https://pharmaobservatory.com*
 | [**conditions_get**](ConditionsApi.md#conditions_get) | **GET** /api/v1/conditions/{id} | One condition |
 | [**conditions_list**](ConditionsApi.md#conditions_list) | **GET** /api/v1/conditions | List conditions |
 | [**conditions_pdufa_dates**](ConditionsApi.md#conditions_pdufa_dates) | **GET** /api/v1/conditions/{id}/pdufa_dates | FDA decision dates (PDUFA) and catalysts |
+| [**conditions_program_licensing_candidates**](ConditionsApi.md#conditions_program_licensing_candidates) | **GET** /api/v1/conditions/{id}/program_licensing_candidates | Program licensing candidates |
+| [**conditions_programs**](ConditionsApi.md#conditions_programs) | **GET** /api/v1/conditions/{id}/programs | Programs |
+| [**conditions_rwd_source_conditions**](ConditionsApi.md#conditions_rwd_source_conditions) | **GET** /api/v1/conditions/{id}/rwd_source_conditions | Real-world data sources named by registered studies of a condition |
+| [**conditions_rwd_study_conditions**](ConditionsApi.md#conditions_rwd_study_conditions) | **GET** /api/v1/conditions/{id}/rwd_study_conditions | Registered real-world data study conditions |
 
 
 ## conditions_company_programs
@@ -1191,3 +1195,319 @@ end
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+
+## conditions_program_licensing_candidates
+
+> <ProgramLicensingCandidatesResponse> conditions_program_licensing_candidates(id, opts)
+
+Program licensing candidates
+
+### 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::ConditionsApi.new
+id = 'D001523' # 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
+  # Program licensing candidates
+  result = api_instance.conditions_program_licensing_candidates(id, opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ConditionsApi->conditions_program_licensing_candidates: #{e}"
+end
+```
+
+#### Using the conditions_program_licensing_candidates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ProgramLicensingCandidatesResponse>, Integer, Hash)> conditions_program_licensing_candidates_with_http_info(id, opts)
+
+```ruby
+begin
+  # Program licensing candidates
+  data, status_code, headers = api_instance.conditions_program_licensing_candidates_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ProgramLicensingCandidatesResponse>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ConditionsApi->conditions_program_licensing_candidates_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
+
+[**ProgramLicensingCandidatesResponse**](ProgramLicensingCandidatesResponse.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## conditions_programs
+
+> <ProgramsResponse> conditions_programs(id, opts)
+
+Programs
+
+### 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::ConditionsApi.new
+id = 'D001523' # 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
+  # Programs
+  result = api_instance.conditions_programs(id, opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ConditionsApi->conditions_programs: #{e}"
+end
+```
+
+#### Using the conditions_programs_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ProgramsResponse>, Integer, Hash)> conditions_programs_with_http_info(id, opts)
+
+```ruby
+begin
+  # Programs
+  data, status_code, headers = api_instance.conditions_programs_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ProgramsResponse>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ConditionsApi->conditions_programs_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
+
+[**ProgramsResponse**](ProgramsResponse.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## conditions_rwd_source_conditions
+
+> <RwdSourceConditionsResponse> conditions_rwd_source_conditions(id, opts)
+
+Real-world data sources named by registered studies of a condition
+
+### 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::ConditionsApi.new
+id = 'D001523' # 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
+  # Real-world data sources named by registered studies of a condition
+  result = api_instance.conditions_rwd_source_conditions(id, opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ConditionsApi->conditions_rwd_source_conditions: #{e}"
+end
+```
+
+#### Using the conditions_rwd_source_conditions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RwdSourceConditionsResponse>, Integer, Hash)> conditions_rwd_source_conditions_with_http_info(id, opts)
+
+```ruby
+begin
+  # Real-world data sources named by registered studies of a condition
+  data, status_code, headers = api_instance.conditions_rwd_source_conditions_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RwdSourceConditionsResponse>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ConditionsApi->conditions_rwd_source_conditions_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
+
+[**RwdSourceConditionsResponse**](RwdSourceConditionsResponse.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## conditions_rwd_study_conditions
+
+> <RwdStudyConditionsResponse> conditions_rwd_study_conditions(id, opts)
+
+Registered real-world data study conditions
+
+### 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::ConditionsApi.new
+id = 'D001523' # 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
+  # Registered real-world data study conditions
+  result = api_instance.conditions_rwd_study_conditions(id, opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ConditionsApi->conditions_rwd_study_conditions: #{e}"
+end
+```
+
+#### Using the conditions_rwd_study_conditions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RwdStudyConditionsResponse>, Integer, Hash)> conditions_rwd_study_conditions_with_http_info(id, opts)
+
+```ruby
+begin
+  # Registered real-world data study conditions
+  data, status_code, headers = api_instance.conditions_rwd_study_conditions_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RwdStudyConditionsResponse>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling ConditionsApi->conditions_rwd_study_conditions_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
+
+[**RwdStudyConditionsResponse**](RwdStudyConditionsResponse.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CroFootprintResponse.md

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

@@ -0,0 +1,34 @@
+# PharmaObservatory::CroFootprintRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **vendor_company_id** | **String** | Company level: the contract research organization's company. | [optional] |
+| **vendor_company_name** | **String** | Display name of the contract research organization's company. | [optional] |
+| **vendor_group_id** | **String** | Group level: the company's current ultimate parent; a root's group is itself. | [optional] |
+| **vendor_group_name** | **String** | Display name of the company's group. | [optional] |
+| **country** | **String** | The country name as the registry's facility roster spells it. | [optional] |
+| **n_trials** | **Integer** | Distinct trials the company delivered with a facility in the country. | [optional] |
+| **n_sites** | **Integer** | Distinct sites (facility keys) in the country across those trials. | [optional] |
+| **latitude** | **Float** | Latitude of the country's approximate centroid. Null for a country with no centroid. | [optional] |
+| **longitude** | **Float** | Longitude of the country's approximate centroid. Null for a country with no centroid. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::CroFootprintRow.new(
+  vendor_company_id: null,
+  vendor_company_name: null,
+  vendor_group_id: null,
+  vendor_group_name: null,
+  country: null,
+  n_trials: null,
+  n_sites: null,
+  latitude: null,
+  longitude: null
+)
+```
+

data/docs/CroTrialsResponse.md

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

@@ -0,0 +1,46 @@
+# PharmaObservatory::CroTrialsRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **trial_id** | **String** | The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number). | [optional] |
+| **vendor_org_id** | **String** | Legal-entity level: the contract research organization's organization record, as filed. | [optional] |
+| **vendor_name** | **String** | The organization's name as filed. | [optional] |
+| **vendor_company_id** | **String** | Company level: the contract research organization's company (null when unresolved). Group by this column for the company leaderboard. | [optional] |
+| **vendor_company_name** | **String** | Display name of the contract research organization's company. | [optional] |
+| **vendor_group_id** | **String** | Group level: the contract research organization's current ultimate parent; a root's group is itself. | [optional] |
+| **vendor_group_name** | **String** | Display name of the contract research organization's group. | [optional] |
+| **attribution_method** | **String** | How the vendor was inferred for the trial: sponsor_match or collaborator_match (the organization is named on the registry record and is on the curated list) or llm_extraction. | [optional] |
+| **confidence** | **Float** | Confidence of the inference, 0 to 1. | [optional] |
+| **phase** | **String** | The registry's phase code of the trial (PHASE1, PHASE2, PHASE3 and so on). Null when the registry gives none. | [optional] |
+| **overall_status** | **String** | The registry's overall status code of the trial (RECRUITING, COMPLETED, TERMINATED and so on). | [optional] |
+| **start_year** | **Integer** | Start year of the trial. | [optional] |
+| **lead_sponsor_name** | **String** | The trial's lead sponsor as filed. | [optional] |
+| **facility_countries** | **Array<String>** | Countries of the trial's facilities. Filter on one country (for example facility_countries=United States) to match trials that list it. | [optional] |
+| **condition_ids** | **Array<String>** | The MeSH (Medical Subject Headings) condition ids of the trial, direct and ancestor (D followed by six to nine digits). Filter on one id (for example condition_ids=D003316) to scope the rows to an indication. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::CroTrialsRow.new(
+  trial_id: null,
+  vendor_org_id: null,
+  vendor_name: null,
+  vendor_company_id: null,
+  vendor_company_name: null,
+  vendor_group_id: null,
+  vendor_group_name: null,
+  attribution_method: null,
+  confidence: null,
+  phase: null,
+  overall_status: null,
+  start_year: null,
+  lead_sponsor_name: null,
+  facility_countries: null,
+  condition_ids: null
+)
+```
+

data/docs/DebarmentsResponse.md

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

@@ -0,0 +1,44 @@
+# PharmaObservatory::DebarmentsRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **debarment_id** | **String** | The debarment id. | [optional] |
+| **firm_name** | **String** | The firm's name as filed with the regulator (the debarred entity). | [optional] |
+| **firm_org_id** | **String** | Legal-entity level: the organization record the firm resolved to (null when the firm did not resolve). | [optional] |
+| **firm_company_id** | **String** | Company level: the firm's company (null when unresolved); the entry key for the companies object type. | [optional] |
+| **firm_company_name** | **String** | Display name of the firm's company. | [optional] |
+| **firm_group_id** | **String** | Group level: the firm's current ultimate parent; a root's group is itself. | [optional] |
+| **firm_group_name** | **String** | Display name of the firm's group. | [optional] |
+| **is_org_resolved** | **Boolean** | True when the firm was attached to an organization. A false row is kept with null firm ids and the name as filed, so an empty read for a company is not proof of no enforcement history. | [optional] |
+| **match_tier** | **String** | How well the firm name was attached to an organization: high, medium or low name-and-geography matches, registry (the operating firm of a registered facility), ambiguous (several candidates, none chosen) or unresolved. Warning letters, untitled letters and debarments attach by firm name alone. | [optional] |
+| **effective_date** | **Date** | The date the debarment took effect. | [optional] |
+| **term** | **String** | The debarment term (for example permanent or a number of years). | [optional] |
+| **fr_citation** | **String** | The Federal Register citation of the notice. | [optional] |
+| **fr_date** | **Date** | The Federal Register publication date. | [optional] |
+| **source_url** | **String** | The FDA debarment list page. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::DebarmentsRow.new(
+  debarment_id: null,
+  firm_name: null,
+  firm_org_id: null,
+  firm_company_id: null,
+  firm_company_name: null,
+  firm_group_id: null,
+  firm_group_name: null,
+  is_org_resolved: null,
+  match_tier: null,
+  effective_date: null,
+  term: null,
+  fr_citation: null,
+  fr_date: null,
+  source_url: null
+)
+```
+