RubyGems - pharmaobservatory - Versions diffs - 0.1.1 → 0.1.3 - Mend

pharmaobservatory 0.1.1 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (469) hide show

data/docs/LegalEntitiesRecord.md ADDED Viewed

@@ -0,0 +1,38 @@
+# PharmaObservatory::LegalEntitiesRecord
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object_type** | **String** |  |  |
+| **id** | **String** |  |  |
+| **record** | [**LegalEntitiesRow**](LegalEntitiesRow.md) |  |  |
+| **attributes** | [**LegalEntitiesRecordAttributes**](LegalEntitiesRecordAttributes.md) |  | [optional] |
+| **datasets** | [**Array&lt;DatasetListing&gt;**](DatasetListing.md) |  |  |
+| **attribution** | [**Array&lt;DatasetAttribution&gt;**](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&lt;String, Object&gt;** |  | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::LegalEntitiesRecord.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/LegalEntitiesRecordAttributes.md ADDED Viewed

@@ -0,0 +1,18 @@
+# PharmaObservatory::LegalEntitiesRecordAttributes
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sponsor_recruitment_duration** | [**SponsorRecruitmentDurationRow**](SponsorRecruitmentDurationRow.md) |  | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::LegalEntitiesRecordAttributes.new(
+  sponsor_recruitment_duration: null
+)
+```

data/docs/LegalEntitiesResponse.md ADDED Viewed

@@ -0,0 +1,58 @@
+# PharmaObservatory::LegalEntitiesResponse
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset** | **String** |  |  |
+| **grain** | **String** |  | [optional] |
+| **object_type** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **scope** | [**BiomarkerCdxAssertionsResponseScope**](BiomarkerCdxAssertionsResponseScope.md) |  | [optional] |
+| **columns** | [**Array&lt;DatasetColumn&gt;**](DatasetColumn.md) |  |  |
+| **rows** | [**Array&lt;LegalEntitiesRow&gt;**](LegalEntitiesRow.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&lt;String&gt;** |  | [optional] |
+| **filters** | **Array&lt;Hash&lt;String, Object&gt;&gt;** |  | [optional] |
+| **group_by** | **Array&lt;String&gt;** |  | [optional] |
+| **measures** | **Array&lt;String&gt;** |  | [optional] |
+| **attribution** | [**Array&lt;DatasetAttribution&gt;**](DatasetAttribution.md) |  | [optional] |
+| **source_credit** | **String** |  | [optional] |
+| **withheld_tiers** | **Array&lt;String&gt;** |  | [optional] |
+| **withheld_columns** | **Array&lt;String&gt;** |  | [optional] |
+| **freshness** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash&lt;String, Object&gt;** |  | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::LegalEntitiesResponse.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/LegalEntitiesRow.md ADDED Viewed

@@ -0,0 +1,56 @@
+# PharmaObservatory::LegalEntitiesRow
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_id** | **String** | The organization record id: a registered legal entity (edgar:, ror:) or a name-resolved sponsor (sponsor:). | [optional] |
+| **org_name** | **String** | The organization&#39;s name. | [optional] |
+| **is_name_resolved_sponsor** | **Boolean** | True for a sponsor resolved from a filed name alone rather than from a registration. | [optional] |
+| **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_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] |
+| **lifecycle_status** | **String** | Lifecycle status from the registry sources. | [optional] |
+| **num_lead_trials** | **Integer** | Trials the organization leads. | [optional] |
+| **num_trials** | **Integer** | Trials the organization leads or collaborates on. | [optional] |
+| **total_lead_enrollment** | **Float** | Planned enrollment across led trials. | [optional] |
+| **num_recent_lead_trials** | **Integer** | Led trials started in the recent window. | [optional] |
+| **activity_score** | **Float** | Trial activity score. | [optional] |
+| **company_id** | **String** | Company level: the company the organization belongs to (null when unresolved). | [optional] |
+| **company_name** | **String** | Display name of the company. | [optional] |
+| **group_id** | **String** | Group level: the company&#39;s current ultimate parent; a root&#39;s group is itself. | [optional] |
+| **group_name** | **String** | Display name of the group. | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::LegalEntitiesRow.new(
+  org_id: null,
+  org_name: null,
+  is_name_resolved_sponsor: null,
+  org_origin: null,
+  country: null,
+  org_type: null,
+  edgar_cik: null,
+  edgar_ticker: null,
+  ror_id: null,
+  lei: null,
+  lifecycle_status: null,
+  num_lead_trials: null,
+  num_trials: null,
+  total_lead_enrollment: null,
+  num_recent_lead_trials: null,
+  activity_score: null,
+  company_id: null,
+  company_name: null,
+  group_id: null,
+  group_name: null
+)
+```

data/docs/PdufaDatesResponse.md ADDED Viewed

@@ -0,0 +1,58 @@
+# PharmaObservatory::PdufaDatesResponse
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset** | **String** |  |  |
+| **grain** | **String** |  | [optional] |
+| **object_type** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **scope** | [**BiomarkerCdxAssertionsResponseScope**](BiomarkerCdxAssertionsResponseScope.md) |  | [optional] |
+| **columns** | [**Array&lt;DatasetColumn&gt;**](DatasetColumn.md) |  |  |
+| **rows** | [**Array&lt;PdufaDatesRow&gt;**](PdufaDatesRow.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&lt;String&gt;** |  | [optional] |
+| **filters** | **Array&lt;Hash&lt;String, Object&gt;&gt;** |  | [optional] |
+| **group_by** | **Array&lt;String&gt;** |  | [optional] |
+| **measures** | **Array&lt;String&gt;** |  | [optional] |
+| **attribution** | [**Array&lt;DatasetAttribution&gt;**](DatasetAttribution.md) |  | [optional] |
+| **source_credit** | **String** |  | [optional] |
+| **withheld_tiers** | **Array&lt;String&gt;** |  | [optional] |
+| **withheld_columns** | **Array&lt;String&gt;** |  | [optional] |
+| **freshness** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash&lt;String, Object&gt;** |  | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::PdufaDatesResponse.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/PdufaDatesRow.md ADDED Viewed

@@ -0,0 +1,66 @@
+# PharmaObservatory::PdufaDatesRow
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **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] |
+| **date_phrase** | **String** | The date as the source words it. | [optional] |
+| **event_type** | **String** | Event type. | [optional] |
+| **event_category** | **String** | Event category (pdufa, adcomm and so on). | [optional] |
+| **drug_name** | **String** | The drug name as filed. | [optional] |
+| **drug_id** | **String** | The drug key. | [optional] |
+| **molecule_id** | **String** | The molecule key. | [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] |
+| **sponsor_company_id** | **String** | Company level: the company the sponsor belongs to (null when unresolved). | [optional] |
+| **sponsor_company_name** | **String** | Display name of the sponsor&#39;s company. | [optional] |
+| **sponsor_group_id** | **String** | Group level: the sponsor&#39;s current ultimate parent company; a root company&#39;s group is itself. | [optional] |
+| **sponsor_group_name** | **String** | Display name of the sponsor&#39;s group. | [optional] |
+| **ticker** | **String** | Exchange ticker. | [optional] |
+| **condition_id** | **String** | The condition key. | [optional] |
+| **condition_name** | **String** | The condition&#39;s name. | [optional] |
+| **indication_text** | **String** | The indication as the source words it. | [optional] |
+| **source_type** | **String** | Kind of source document. | [optional] |
+| **source_link** | **String** | Link to the source document. | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::PdufaDatesRow.new(
+  pdufa_date_id: null,
+  source: null,
+  restriction_tier: null,
+  decision_date: null,
+  date_start: null,
+  date_end: null,
+  date_precision: null,
+  date_phrase: null,
+  event_type: null,
+  event_category: null,
+  drug_name: null,
+  drug_id: null,
+  molecule_id: null,
+  sponsor_name: null,
+  sponsor_org_id: null,
+  sponsor_company_id: null,
+  sponsor_company_name: null,
+  sponsor_group_id: null,
+  sponsor_group_name: null,
+  ticker: null,
+  condition_id: null,
+  condition_name: null,
+  indication_text: null,
+  source_type: null,
+  source_link: null
+)
+```

data/docs/QueryApi.md ADDED Viewed

@@ -0,0 +1,149 @@
+# PharmaObservatory::QueryApi
+All URIs are relative to *https://pharmaobservatory.com*
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**query_result**](QueryApi.md#query_result) | **GET** /api/v1/results/{result_id} | Page a stored result |
+| [**query_run**](QueryApi.md#query_run) | **POST** /api/v1/query | Run a SQL query |
+## query_result
+> <ResultPage> query_result(result_id, opts)
+Page a stored result
+### 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::QueryApi.new
+result_id = '5d3f6a1e-0c1b-4f7e-9a52-2b8c1d4e6f70' # String |
+opts = {
+  cursor: 'eyJvIjoyMDB9' # String |
+}
+begin
+  # Page a stored result
+  result = api_instance.query_result(result_id, opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling QueryApi->query_result: #{e}"
+end
+```
+#### Using the query_result_with_http_info variant
+This returns an Array which contains the response data, status code and headers.
+> <Array(<ResultPage>, Integer, Hash)> query_result_with_http_info(result_id, opts)
+```ruby
+begin
+  # Page a stored result
+  data, status_code, headers = api_instance.query_result_with_http_info(result_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ResultPage>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling QueryApi->query_result_with_http_info: #{e}"
+end
+```
+### Parameters
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **result_id** | **String** |  |  |
+| **cursor** | **String** |  | [optional] |
+### Return type
+[**ResultPage**](ResultPage.md)
+### Authorization
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+### HTTP request headers
+- **Content-Type**: Not defined
+- **Accept**: application/json
+## query_run
+> <QueryResponse> query_run(opts)
+Run a SQL query
+### 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::QueryApi.new
+opts = {
+  query_run_request: PharmaObservatory::QueryRunRequest.new({sql: 'sql_example'}) # QueryRunRequest |
+}
+begin
+  # Run a SQL query
+  result = api_instance.query_run(opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling QueryApi->query_run: #{e}"
+end
+```
+#### Using the query_run_with_http_info variant
+This returns an Array which contains the response data, status code and headers.
+> <Array(<QueryResponse>, Integer, Hash)> query_run_with_http_info(opts)
+```ruby
+begin
+  # Run a SQL query
+  data, status_code, headers = api_instance.query_run_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <QueryResponse>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling QueryApi->query_run_with_http_info: #{e}"
+end
+```
+### Parameters
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **query_run_request** | [**QueryRunRequest**](QueryRunRequest.md) |  | [optional] |
+### Return type
+[**QueryResponse**](QueryResponse.md)
+### Authorization
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+### HTTP request headers
+- **Content-Type**: application/json
+- **Accept**: application/json

data/docs/QueryError.md ADDED Viewed

@@ -0,0 +1,24 @@
+# PharmaObservatory::QueryError
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error_code** | **String** |  |  |
+| **message** | **String** |  |  |
+| **hint** | **String** |  | [optional] |
+| **docs** | **String** |  | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::QueryError.new(
+  error_code: null,
+  message: null,
+  hint: null,
+  docs: null
+)
+```

data/docs/QueryResponse.md ADDED Viewed

@@ -0,0 +1,42 @@
+# PharmaObservatory::QueryResponse
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **columns** | [**Array&lt;QueryResponseColumnsInner&gt;**](QueryResponseColumnsInner.md) |  |  |
+| **rows** | **Array&lt;Array&lt;Object&gt;&gt;** |  |  |
+| **total_rows** | **Integer** |  | [optional] |
+| **truncated** | **Boolean** |  | [optional] |
+| **result_id** | **String** |  |  |
+| **next_cursor** | **String** |  | [optional] |
+| **attribution** | [**Array&lt;DatasetAttribution&gt;**](DatasetAttribution.md) |  | [optional] |
+| **source_credit** | **String** |  | [optional] |
+| **withheld_tiers** | **Array&lt;String&gt;** |  | [optional] |
+| **withheld_columns** | **Array&lt;String&gt;** |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **dataset** | **String** |  |  |
+| **notice** | **String** |  | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::QueryResponse.new(
+  columns: null,
+  rows: null,
+  total_rows: null,
+  truncated: null,
+  result_id: null,
+  next_cursor: null,
+  attribution: null,
+  source_credit: null,
+  withheld_tiers: null,
+  withheld_columns: null,
+  build_state: null,
+  dataset: null,
+  notice: null
+)
+```

data/docs/QueryResponseColumnsInner.md ADDED Viewed

@@ -0,0 +1,20 @@
+# PharmaObservatory::QueryResponseColumnsInner
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::QueryResponseColumnsInner.new(
+  name: null,
+  type: null
+)
+```

data/docs/QueryRunRequest.md ADDED Viewed

@@ -0,0 +1,18 @@
+# PharmaObservatory::QueryRunRequest
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sql** | **String** |  |  |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::QueryRunRequest.new(
+  sql: null
+)
+```

data/docs/ResultPage.md ADDED Viewed

@@ -0,0 +1,38 @@
+# PharmaObservatory::ResultPage
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **columns** | [**Array&lt;QueryResponseColumnsInner&gt;**](QueryResponseColumnsInner.md) |  |  |
+| **rows** | **Array&lt;Array&lt;Object&gt;&gt;** |  |  |
+| **total_rows** | **Integer** |  | [optional] |
+| **truncated** | **Boolean** |  | [optional] |
+| **result_id** | **String** |  |  |
+| **next_cursor** | **String** |  | [optional] |
+| **attribution** | [**Array&lt;DatasetAttribution&gt;**](DatasetAttribution.md) |  | [optional] |
+| **source_credit** | **String** |  | [optional] |
+| **withheld_tiers** | **Array&lt;String&gt;** |  | [optional] |
+| **withheld_columns** | **Array&lt;String&gt;** |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::ResultPage.new(
+  columns: null,
+  rows: null,
+  total_rows: null,
+  truncated: null,
+  result_id: null,
+  next_cursor: null,
+  attribution: null,
+  source_credit: null,
+  withheld_tiers: null,
+  withheld_columns: null,
+  build_state: null
+)
+```

data/docs/SiteBedsYearlyResponse.md ADDED Viewed

@@ -0,0 +1,58 @@
+# PharmaObservatory::SiteBedsYearlyResponse
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset** | **String** |  |  |
+| **grain** | **String** |  | [optional] |
+| **object_type** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **scope** | [**BiomarkerCdxAssertionsResponseScope**](BiomarkerCdxAssertionsResponseScope.md) |  | [optional] |
+| **columns** | [**Array&lt;DatasetColumn&gt;**](DatasetColumn.md) |  |  |
+| **rows** | [**Array&lt;SiteBedsYearlyRow&gt;**](SiteBedsYearlyRow.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&lt;String&gt;** |  | [optional] |
+| **filters** | **Array&lt;Hash&lt;String, Object&gt;&gt;** |  | [optional] |
+| **group_by** | **Array&lt;String&gt;** |  | [optional] |
+| **measures** | **Array&lt;String&gt;** |  | [optional] |
+| **attribution** | [**Array&lt;DatasetAttribution&gt;**](DatasetAttribution.md) |  | [optional] |
+| **source_credit** | **String** |  | [optional] |
+| **withheld_tiers** | **Array&lt;String&gt;** |  | [optional] |
+| **withheld_columns** | **Array&lt;String&gt;** |  | [optional] |
+| **freshness** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash&lt;String, Object&gt;** |  | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::SiteBedsYearlyResponse.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/SiteBedsYearlyRow.md ADDED Viewed

@@ -0,0 +1,30 @@
+# PharmaObservatory::SiteBedsYearlyRow
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **site_id** | **String** | The site key: one facility spelling from the registry. | [optional] |
+| **year** | **Integer** | The registry year. | [optional] |
+| **ccn** | **String** | CMS Certification Number of the matched hospital. | [optional] |
+| **bed_count** | **Integer** | Certified bed count that year. | [optional] |
+| **is_teaching** | **Boolean** | Whether the hospital was a teaching hospital that year. | [optional] |
+| **pos_vintage** | **String** | The Provider of Services file vintage the row comes from. | [optional] |
+| **as_of** | **Date** | The as-of date of that file. | [optional] |
+## Example
+```ruby
+require 'pharmaobservatory'
+instance = PharmaObservatory::SiteBedsYearlyRow.new(
+  site_id: null,
+  year: null,
+  ccn: null,
+  bed_count: null,
+  is_teaching: null,
+  pos_vintage: null,
+  as_of: null
+)
+```