pharmaobservatory 0.1.13 → 0.1.15

data/docs/SubscriptionsApi.md

@@ -0,0 +1,282 @@
+# PharmaObservatory::SubscriptionsApi
+
+All URIs are relative to *https://pharmaobservatory.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**changes_list**](SubscriptionsApi.md#changes_list) | **GET** /api/v1/changes | Changes since a cursor |
+| [**subscriptions_create**](SubscriptionsApi.md#subscriptions_create) | **POST** /api/v1/subscriptions | Follow an entity or a dataset query |
+| [**subscriptions_delete**](SubscriptionsApi.md#subscriptions_delete) | **DELETE** /api/v1/subscriptions/{id} | Stop following |
+| [**subscriptions_list**](SubscriptionsApi.md#subscriptions_list) | **GET** /api/v1/subscriptions | List your subscriptions |
+
+
+## changes_list
+
+> <ChangesList200Response> changes_list(opts)
+
+Changes since a cursor
+
+### 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::SubscriptionsApi.new
+opts = {
+  cursor: 'eyJ2IjoxLCJvIjoiMjAyNi0xMS0wMlQwNjowMjowMC4wMDAwMDBaIiwiaSI6OTAwMn0', # String | 
+  limit: 2 # Integer | 
+}
+
+begin
+  # Changes since a cursor
+  result = api_instance.changes_list(opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling SubscriptionsApi->changes_list: #{e}"
+end
+```
+
+#### Using the changes_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ChangesList200Response>, Integer, Hash)> changes_list_with_http_info(opts)
+
+```ruby
+begin
+  # Changes since a cursor
+  data, status_code, headers = api_instance.changes_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ChangesList200Response>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling SubscriptionsApi->changes_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cursor** | **String** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+
+### Return type
+
+[**ChangesList200Response**](ChangesList200Response.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## subscriptions_create
+
+> <SubscriptionsCreate201Response> subscriptions_create(opts)
+
+Follow an entity or a dataset 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::SubscriptionsApi.new
+opts = {
+  subscriptions_create_request: PharmaObservatory::SubscriptionsCreateRequest.new({object_type: 'object_type_example', entity_id: 'entity_id_example'}) # SubscriptionsCreateRequest | 
+}
+
+begin
+  # Follow an entity or a dataset query
+  result = api_instance.subscriptions_create(opts)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling SubscriptionsApi->subscriptions_create: #{e}"
+end
+```
+
+#### Using the subscriptions_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SubscriptionsCreate201Response>, Integer, Hash)> subscriptions_create_with_http_info(opts)
+
+```ruby
+begin
+  # Follow an entity or a dataset query
+  data, status_code, headers = api_instance.subscriptions_create_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SubscriptionsCreate201Response>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling SubscriptionsApi->subscriptions_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subscriptions_create_request** | [**SubscriptionsCreateRequest**](SubscriptionsCreateRequest.md) |  | [optional] |
+
+### Return type
+
+[**SubscriptionsCreate201Response**](SubscriptionsCreate201Response.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## subscriptions_delete
+
+> <SubscriptionsDelete200Response> subscriptions_delete(id)
+
+Stop following
+
+### 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::SubscriptionsApi.new
+id = 4242 # Integer | 
+
+begin
+  # Stop following
+  result = api_instance.subscriptions_delete(id)
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling SubscriptionsApi->subscriptions_delete: #{e}"
+end
+```
+
+#### Using the subscriptions_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SubscriptionsDelete200Response>, Integer, Hash)> subscriptions_delete_with_http_info(id)
+
+```ruby
+begin
+  # Stop following
+  data, status_code, headers = api_instance.subscriptions_delete_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SubscriptionsDelete200Response>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling SubscriptionsApi->subscriptions_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+
+### Return type
+
+[**SubscriptionsDelete200Response**](SubscriptionsDelete200Response.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## subscriptions_list
+
+> <SubscriptionsList200Response> subscriptions_list
+
+List your subscriptions
+
+### 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::SubscriptionsApi.new
+
+begin
+  # List your subscriptions
+  result = api_instance.subscriptions_list
+  p result
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling SubscriptionsApi->subscriptions_list: #{e}"
+end
+```
+
+#### Using the subscriptions_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SubscriptionsList200Response>, Integer, Hash)> subscriptions_list_with_http_info
+
+```ruby
+begin
+  # List your subscriptions
+  data, status_code, headers = api_instance.subscriptions_list_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SubscriptionsList200Response>
+rescue PharmaObservatory::ApiError => e
+  puts "Error when calling SubscriptionsApi->subscriptions_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**SubscriptionsList200Response**](SubscriptionsList200Response.md)
+
+### Authorization
+
+[ApiBearerJwt](../README.md#ApiBearerJwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/SubscriptionsCreate201Response.md

@@ -0,0 +1,22 @@
+# PharmaObservatory::SubscriptionsCreate201Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subscription** | [**SubscriptionsCreate201ResponseSubscription**](SubscriptionsCreate201ResponseSubscription.md) |  |  |
+| **created** | **Boolean** |  |  |
+| **build_state** | [**ChangesList200ResponseBuildState**](ChangesList200ResponseBuildState.md) |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::SubscriptionsCreate201Response.new(
+  subscription: null,
+  created: null,
+  build_state: null
+)
+```
+

data/docs/SubscriptionsCreate201ResponseSubscription.md

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

data/docs/SubscriptionsCreate201ResponseSubscriptionTarget.md

@@ -0,0 +1,22 @@
+# PharmaObservatory::SubscriptionsCreate201ResponseSubscriptionTarget
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **kind** | **String** |  |  |
+| **object_type** | **String** |  |  |
+| **entity_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::SubscriptionsCreate201ResponseSubscriptionTarget.new(
+  kind: null,
+  object_type: null,
+  entity_id: null
+)
+```
+

data/docs/SubscriptionsCreateRequest.md

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

data/docs/SubscriptionsDelete200Response.md

@@ -0,0 +1,24 @@
+# PharmaObservatory::SubscriptionsDelete200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deleted** | **Boolean** |  |  |
+| **id** | **Integer** |  |  |
+| **label** | **String** |  |  |
+| **build_state** | [**ChangesList200ResponseBuildState**](ChangesList200ResponseBuildState.md) |  |  |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::SubscriptionsDelete200Response.new(
+  deleted: null,
+  id: null,
+  label: null,
+  build_state: null
+)
+```
+

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/companies_api.rb

@@ -656,6 +656,97 @@ module PharmaObservatory
       return data, status_code, headers
     end
 
+    # Company asset collisions
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
+    # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
+    # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort=a,-b.
+    # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
+    # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
+    # @option opts [String] :scope company (this company only) or group (its corporate group).
+    # @return [CompanyAssetCollisionsResponse]
+    def companies_company_asset_collisions(id, opts = {})
+      data, _status_code, _headers = companies_company_asset_collisions_with_http_info(id, opts)
+      data
+    end
+
+    # Company asset collisions
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
+    # @option opts [Integer] :limit Rows per page, up to 500 (default 50).
+    # @option opts [String] :sort Comma separated columns, a leading minus for descending: sort=a,-b.
+    # @option opts [String] :group_by A dimension to group by; a date takes :year, :quarter or :month.
+    # @option opts [String] :measure count, sum(col), avg(col), min(col), max(col), median(col) or count_distinct(col).
+    # @option opts [String] :scope company (this company only) or group (its corporate group).
+    # @return [Array<(CompanyAssetCollisionsResponse, Integer, Hash)>] CompanyAssetCollisionsResponse data, response status code and response headers
+    def companies_company_asset_collisions_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompaniesApi.companies_company_asset_collisions ...'
+      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 CompaniesApi.companies_company_asset_collisions"
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CompaniesApi.companies_company_asset_collisions, must be smaller than or equal to 500.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CompaniesApi.companies_company_asset_collisions, must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["company", "group"]
+      if @api_client.config.client_side_validation && opts[:'scope'] && !allowable_values.include?(opts[:'scope'])
+        fail ArgumentError, "invalid value for \"scope\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api/v1/companies/{id}/company_asset_collisions'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # 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?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'group_by'] = opts[:'group_by'] if !opts[:'group_by'].nil?
+      query_params[:'measure'] = opts[:'measure'] if !opts[:'measure'].nil?
+      query_params[:'scope'] = opts[:'scope'] if !opts[:'scope'].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] || 'CompanyAssetCollisionsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiBearerJwt']
+
+      new_options = opts.merge(
+        :operation => :"CompaniesApi.companies_company_asset_collisions",
+        :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: CompaniesApi#companies_company_asset_collisions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Company assets (approved and marketed drugs)
     # @param id [String] 
     # @param [Hash] opts the optional parameters
@@ -1020,7 +1111,7 @@ module PharmaObservatory
       return data, status_code, headers
     end
 
-    # Company program overlap
+    # Company competitors by asset collision
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.
@@ -1035,7 +1126,7 @@ module PharmaObservatory
       data
     end
 
-    # Company program overlap
+    # Company competitors by asset collision
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :cursor The next_cursor of the previous page. Opaque; it is bound to the filters and the warehouse build that issued it.