pharmaobservatory 0.1.13 → 0.1.14

data/docs/SubscriptionsList200Response.md

@@ -0,0 +1,22 @@
+# PharmaObservatory::SubscriptionsList200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subscriptions** | [**Array<SubscriptionsList200ResponseSubscriptionsInner>**](SubscriptionsList200ResponseSubscriptionsInner.md) |  |  |
+| **count** | **Integer** |  |  |
+| **build_state** | [**ChangesList200ResponseBuildState**](ChangesList200ResponseBuildState.md) |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::SubscriptionsList200Response.new(
+  subscriptions: null,
+  count: null,
+  build_state: null
+)
+```
+

data/docs/SubscriptionsList200ResponseSubscriptionsInner.md

@@ -0,0 +1,28 @@
+# PharmaObservatory::SubscriptionsList200ResponseSubscriptionsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **label** | **String** |  |  |
+| **target** | [**SubscriptionsList200ResponseSubscriptionsInnerTarget**](SubscriptionsList200ResponseSubscriptionsInnerTarget.md) |  |  |
+| **event_types** | **Array<String>** |  |  |
+| **paused** | **Boolean** |  |  |
+| **created_at** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::SubscriptionsList200ResponseSubscriptionsInner.new(
+  id: null,
+  label: null,
+  target: null,
+  event_types: null,
+  paused: null,
+  created_at: null
+)
+```
+

data/docs/SubscriptionsList200ResponseSubscriptionsInnerTarget.md

@@ -0,0 +1,26 @@
+# PharmaObservatory::SubscriptionsList200ResponseSubscriptionsInnerTarget
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **kind** | **String** |  |  |
+| **dataset** | **String** |  | [optional] |
+| **filters** | [**SubscriptionsList200ResponseSubscriptionsInnerTargetFilters**](SubscriptionsList200ResponseSubscriptionsInnerTargetFilters.md) |  | [optional] |
+| **object_type** | **String** |  | [optional] |
+| **entity_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::SubscriptionsList200ResponseSubscriptionsInnerTarget.new(
+  kind: null,
+  dataset: null,
+  filters: null,
+  object_type: null,
+  entity_id: null
+)
+```
+

data/docs/SubscriptionsList200ResponseSubscriptionsInnerTargetFilters.md

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

data/lib/pharmaobservatory/api/subscriptions_api.rb

@@ -0,0 +1,261 @@
+=begin
+#Pharma Observatory Public REST API
+
+#Read-only REST API over the Pharma Observatory biomedical data platform. Reference: https://pharmaobservatory.com/api-reference
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'cgi'
+
+module PharmaObservatory
+  class SubscriptionsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Changes since a cursor
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor 
+    # @option opts [Integer] :limit 
+    # @return [ChangesList200Response]
+    def changes_list(opts = {})
+      data, _status_code, _headers = changes_list_with_http_info(opts)
+      data
+    end
+
+    # Changes since a cursor
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor 
+    # @option opts [Integer] :limit 
+    # @return [Array<(ChangesList200Response, Integer, Hash)>] ChangesList200Response data, response status code and response headers
+    def changes_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SubscriptionsApi.changes_list ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/changes'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ChangesList200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiBearerJwt']
+
+      new_options = opts.merge(
+        :operation => :"SubscriptionsApi.changes_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SubscriptionsApi#changes_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Follow an entity or a dataset query
+    # @param [Hash] opts the optional parameters
+    # @option opts [SubscriptionsCreateRequest] :subscriptions_create_request 
+    # @return [SubscriptionsCreate201Response]
+    def subscriptions_create(opts = {})
+      data, _status_code, _headers = subscriptions_create_with_http_info(opts)
+      data
+    end
+
+    # Follow an entity or a dataset query
+    # @param [Hash] opts the optional parameters
+    # @option opts [SubscriptionsCreateRequest] :subscriptions_create_request 
+    # @return [Array<(SubscriptionsCreate201Response, Integer, Hash)>] SubscriptionsCreate201Response data, response status code and response headers
+    def subscriptions_create_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SubscriptionsApi.subscriptions_create ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/subscriptions'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'subscriptions_create_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SubscriptionsCreate201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiBearerJwt']
+
+      new_options = opts.merge(
+        :operation => :"SubscriptionsApi.subscriptions_create",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SubscriptionsApi#subscriptions_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Stop following
+    # @param id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [SubscriptionsDelete200Response]
+    def subscriptions_delete(id, opts = {})
+      data, _status_code, _headers = subscriptions_delete_with_http_info(id, opts)
+      data
+    end
+
+    # Stop following
+    # @param id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SubscriptionsDelete200Response, Integer, Hash)>] SubscriptionsDelete200Response data, response status code and response headers
+    def subscriptions_delete_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SubscriptionsApi.subscriptions_delete ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling SubscriptionsApi.subscriptions_delete"
+      end
+      # resource path
+      local_var_path = '/api/v1/subscriptions/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SubscriptionsDelete200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiBearerJwt']
+
+      new_options = opts.merge(
+        :operation => :"SubscriptionsApi.subscriptions_delete",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SubscriptionsApi#subscriptions_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List your subscriptions
+    # @param [Hash] opts the optional parameters
+    # @return [SubscriptionsList200Response]
+    def subscriptions_list(opts = {})
+      data, _status_code, _headers = subscriptions_list_with_http_info(opts)
+      data
+    end
+
+    # List your subscriptions
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SubscriptionsList200Response, Integer, Hash)>] SubscriptionsList200Response data, response status code and response headers
+    def subscriptions_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SubscriptionsApi.subscriptions_list ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/subscriptions'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SubscriptionsList200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiBearerJwt']
+
+      new_options = opts.merge(
+        :operation => :"SubscriptionsApi.subscriptions_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SubscriptionsApi#subscriptions_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/pharmaobservatory/models/biomarker_validation_row.rb

@@ -82,7 +82,7 @@ module PharmaObservatory
     # A link to the cited record.
     attr_accessor :citation_url
 
-    # False for the FDA Biomarker Qualification Program arm, whose captured links are known to go stale; true otherwise. A link marked false may not resolve.
+    # True on every row. Kept for contract stability; the FDA Biomarker Qualification Program links were rebuilt on the current FDA host (#5778).
     attr_accessor :citation_verified
 
     # The text span the evidence rests on, where the source gives one.