pharmaobservatory 0.1.4 → 0.1.6

data/lib/pharmaobservatory/models/conditions_response.rb

@@ -102,7 +102,7 @@ module PharmaObservatory
         :'grain' => :'String',
         :'object_type' => :'String',
         :'id' => :'String',
-        :'scope' => :'BiomarkerCdxAssertionsResponseScope',
+        :'scope' => :'BiomarkerAssayEvidenceResponseScope',
         :'columns' => :'Array<DatasetColumn>',
         :'rows' => :'Array<ConditionsRow>',
         :'total' => :'Integer',
@@ -115,8 +115,8 @@ module PharmaObservatory
         :'source_credit' => :'String',
         :'withheld_tiers' => :'Array<String>',
         :'withheld_columns' => :'Array<String>',
-        :'freshness' => :'BiomarkerCdxAssertionsResponseFreshness',
-        :'build' => :'BiomarkerCdxAssertionsResponseBuild',
+        :'freshness' => :'BiomarkerAssayEvidenceResponseFreshness',
+        :'build' => :'BiomarkerAssayEvidenceResponseBuild',
         :'build_state' => :'DatasetBuildState',
         :'restriction' => :'Hash<String, Object>'
       }

data/lib/pharmaobservatory/models/drug_patent_cliff_response.rb

@@ -102,7 +102,7 @@ module PharmaObservatory
         :'grain' => :'String',
         :'object_type' => :'String',
         :'id' => :'String',
-        :'scope' => :'BiomarkerCdxAssertionsResponseScope',
+        :'scope' => :'BiomarkerAssayEvidenceResponseScope',
         :'columns' => :'Array<DatasetColumn>',
         :'rows' => :'Array<DrugPatentCliffRow>',
         :'total' => :'Integer',
@@ -115,8 +115,8 @@ module PharmaObservatory
         :'source_credit' => :'String',
         :'withheld_tiers' => :'Array<String>',
         :'withheld_columns' => :'Array<String>',
-        :'freshness' => :'BiomarkerCdxAssertionsResponseFreshness',
-        :'build' => :'BiomarkerCdxAssertionsResponseBuild',
+        :'freshness' => :'BiomarkerAssayEvidenceResponseFreshness',
+        :'build' => :'BiomarkerAssayEvidenceResponseBuild',
         :'build_state' => :'DatasetBuildState',
         :'restriction' => :'Hash<String, Object>'
       }

data/lib/pharmaobservatory/models/institutional_holdings_response.rb

@@ -102,7 +102,7 @@ module PharmaObservatory
         :'grain' => :'String',
         :'object_type' => :'String',
         :'id' => :'String',
-        :'scope' => :'BiomarkerCdxAssertionsResponseScope',
+        :'scope' => :'BiomarkerAssayEvidenceResponseScope',
         :'columns' => :'Array<DatasetColumn>',
         :'rows' => :'Array<InstitutionalHoldingsRow>',
         :'total' => :'Integer',
@@ -115,8 +115,8 @@ module PharmaObservatory
         :'source_credit' => :'String',
         :'withheld_tiers' => :'Array<String>',
         :'withheld_columns' => :'Array<String>',
-        :'freshness' => :'BiomarkerCdxAssertionsResponseFreshness',
-        :'build' => :'BiomarkerCdxAssertionsResponseBuild',
+        :'freshness' => :'BiomarkerAssayEvidenceResponseFreshness',
+        :'build' => :'BiomarkerAssayEvidenceResponseBuild',
         :'build_state' => :'DatasetBuildState',
         :'restriction' => :'Hash<String, Object>'
       }

data/lib/pharmaobservatory/models/institutional_holdings_row.rb

@@ -46,6 +46,12 @@ module PharmaObservatory
     # The institutional manager's stable identity (an SEC registration number), the key that groups all of one manager's holdings.
     attr_accessor :holder_identity_key
 
+    # The manager's investor key where the link resolves (null when the manager resolves to no investor or its rows disagree). A manager-level value: the same on every row of one manager.
+    attr_accessor :holder_investor_id
+
+    # True when the manager's own holding rows resolve to different investors, so holder_investor_id is null.
+    attr_accessor :holder_link_conflict
+
     # Manager kind.
     attr_accessor :holder_kind
 
@@ -64,12 +70,15 @@ module PharmaObservatory
     # Display name of the manager's group.
     attr_accessor :holder_group_name
 
-    # Reported value of the position.
+    # Reported value of the position in whole US dollars at the filing's inferred value scale; equity (SH) lines only. Null where the scale or currency is ambiguous.
     attr_accessor :reported_value_amount
 
     # Currency of the reported value.
     attr_accessor :reported_value_currency
 
+    # How the share figure was reached: sum_latest_period_positions, the sum of the manager's positions in the issuer's latest reporting period. Read a share figure with its basis.
+    attr_accessor :shares_basis
+
     # Shares standing.
     attr_accessor :shares
 
@@ -104,6 +113,8 @@ module PharmaObservatory
         :'security_ref' => :'security_ref',
         :'holder_name' => :'holder_name',
         :'holder_identity_key' => :'holder_identity_key',
+        :'holder_investor_id' => :'holder_investor_id',
+        :'holder_link_conflict' => :'holder_link_conflict',
         :'holder_kind' => :'holder_kind',
         :'holder_org_id' => :'holder_org_id',
         :'holder_company_id' => :'holder_company_id',
@@ -112,6 +123,7 @@ module PharmaObservatory
         :'holder_group_name' => :'holder_group_name',
         :'reported_value_amount' => :'reported_value_amount',
         :'reported_value_currency' => :'reported_value_currency',
+        :'shares_basis' => :'shares_basis',
         :'shares' => :'shares',
         :'percent_basis' => :'percent_basis',
         :'reported_percent' => :'reported_percent',
@@ -145,6 +157,8 @@ module PharmaObservatory
         :'security_ref' => :'String',
         :'holder_name' => :'String',
         :'holder_identity_key' => :'String',
+        :'holder_investor_id' => :'String',
+        :'holder_link_conflict' => :'Boolean',
         :'holder_kind' => :'String',
         :'holder_org_id' => :'String',
         :'holder_company_id' => :'String',
@@ -153,6 +167,7 @@ module PharmaObservatory
         :'holder_group_name' => :'String',
         :'reported_value_amount' => :'Float',
         :'reported_value_currency' => :'String',
+        :'shares_basis' => :'String',
         :'shares' => :'Float',
         :'percent_basis' => :'String',
         :'reported_percent' => :'Float',
@@ -176,6 +191,8 @@ module PharmaObservatory
         :'security_ref',
         :'holder_name',
         :'holder_identity_key',
+        :'holder_investor_id',
+        :'holder_link_conflict',
         :'holder_kind',
         :'holder_org_id',
         :'holder_company_id',
@@ -184,6 +201,7 @@ module PharmaObservatory
         :'holder_group_name',
         :'reported_value_amount',
         :'reported_value_currency',
+        :'shares_basis',
         :'shares',
         :'percent_basis',
         :'reported_percent',
@@ -250,6 +268,14 @@ module PharmaObservatory
         self.holder_identity_key = attributes[:'holder_identity_key']
       end
 
+      if attributes.key?(:'holder_investor_id')
+        self.holder_investor_id = attributes[:'holder_investor_id']
+      end
+
+      if attributes.key?(:'holder_link_conflict')
+        self.holder_link_conflict = attributes[:'holder_link_conflict']
+      end
+
       if attributes.key?(:'holder_kind')
         self.holder_kind = attributes[:'holder_kind']
       end
@@ -282,6 +308,10 @@ module PharmaObservatory
         self.reported_value_currency = attributes[:'reported_value_currency']
       end
 
+      if attributes.key?(:'shares_basis')
+        self.shares_basis = attributes[:'shares_basis']
+      end
+
       if attributes.key?(:'shares')
         self.shares = attributes[:'shares']
       end
@@ -341,6 +371,8 @@ module PharmaObservatory
           security_ref == o.security_ref &&
           holder_name == o.holder_name &&
           holder_identity_key == o.holder_identity_key &&
+          holder_investor_id == o.holder_investor_id &&
+          holder_link_conflict == o.holder_link_conflict &&
           holder_kind == o.holder_kind &&
           holder_org_id == o.holder_org_id &&
           holder_company_id == o.holder_company_id &&
@@ -349,6 +381,7 @@ module PharmaObservatory
           holder_group_name == o.holder_group_name &&
           reported_value_amount == o.reported_value_amount &&
           reported_value_currency == o.reported_value_currency &&
+          shares_basis == o.shares_basis &&
           shares == o.shares &&
           percent_basis == o.percent_basis &&
           reported_percent == o.reported_percent &&
@@ -367,7 +400,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [holding_id, issuer_name, issuer_org_id, issuer_company_id, issuer_company_name, issuer_group_id, issuer_group_name, security_ref, holder_name, holder_identity_key, holder_kind, holder_org_id, holder_company_id, holder_company_name, holder_group_id, holder_group_name, reported_value_amount, reported_value_currency, shares, percent_basis, reported_percent, edge_state, first_observed_date, last_filing_date, contains_personal_data].hash
+      [holding_id, issuer_name, issuer_org_id, issuer_company_id, issuer_company_name, issuer_group_id, issuer_group_name, security_ref, holder_name, holder_identity_key, holder_investor_id, holder_link_conflict, holder_kind, holder_org_id, holder_company_id, holder_company_name, holder_group_id, holder_group_name, reported_value_amount, reported_value_currency, shares_basis, shares, percent_basis, reported_percent, edge_state, first_observed_date, last_filing_date, contains_personal_data].hash
     end
 
     # Builds the object from hash

data/lib/pharmaobservatory/models/investor_funds_response.rb

@@ -0,0 +1,478 @@
+=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 'date'
+require 'time'
+
+module PharmaObservatory
+  class InvestorFundsResponse
+    attr_accessor :dataset
+
+    attr_accessor :grain
+
+    attr_accessor :object_type
+
+    attr_accessor :id
+
+    attr_accessor :scope
+
+    attr_accessor :columns
+
+    attr_accessor :rows
+
+    # The exact count of the filtered rows on an ungrouped read, carried by the cursor; null when grouped.
+    attr_accessor :total
+
+    attr_accessor :next_cursor
+
+    attr_accessor :sort
+
+    attr_accessor :filters
+
+    attr_accessor :group_by
+
+    attr_accessor :measures
+
+    attr_accessor :attribution
+
+    attr_accessor :source_credit
+
+    attr_accessor :withheld_tiers
+
+    attr_accessor :withheld_columns
+
+    attr_accessor :freshness
+
+    attr_accessor :build
+
+    attr_accessor :build_state
+
+    attr_accessor :restriction
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'dataset' => :'dataset',
+        :'grain' => :'grain',
+        :'object_type' => :'object_type',
+        :'id' => :'id',
+        :'scope' => :'scope',
+        :'columns' => :'columns',
+        :'rows' => :'rows',
+        :'total' => :'total',
+        :'next_cursor' => :'next_cursor',
+        :'sort' => :'sort',
+        :'filters' => :'filters',
+        :'group_by' => :'group_by',
+        :'measures' => :'measures',
+        :'attribution' => :'attribution',
+        :'source_credit' => :'source_credit',
+        :'withheld_tiers' => :'withheld_tiers',
+        :'withheld_columns' => :'withheld_columns',
+        :'freshness' => :'freshness',
+        :'build' => :'build',
+        :'build_state' => :'build_state',
+        :'restriction' => :'restriction'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'dataset' => :'String',
+        :'grain' => :'String',
+        :'object_type' => :'String',
+        :'id' => :'String',
+        :'scope' => :'BiomarkerAssayEvidenceResponseScope',
+        :'columns' => :'Array<DatasetColumn>',
+        :'rows' => :'Array<InvestorFundsRow>',
+        :'total' => :'Integer',
+        :'next_cursor' => :'String',
+        :'sort' => :'Array<String>',
+        :'filters' => :'Array<Hash<String, Object>>',
+        :'group_by' => :'Array<String>',
+        :'measures' => :'Array<String>',
+        :'attribution' => :'Array<DatasetAttribution>',
+        :'source_credit' => :'String',
+        :'withheld_tiers' => :'Array<String>',
+        :'withheld_columns' => :'Array<String>',
+        :'freshness' => :'BiomarkerAssayEvidenceResponseFreshness',
+        :'build' => :'BiomarkerAssayEvidenceResponseBuild',
+        :'build_state' => :'DatasetBuildState',
+        :'restriction' => :'Hash<String, Object>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'object_type',
+        :'id',
+        :'scope',
+        :'total',
+        :'next_cursor',
+        :'restriction'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PharmaObservatory::InvestorFundsResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PharmaObservatory::InvestorFundsResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'dataset')
+        self.dataset = attributes[:'dataset']
+      else
+        self.dataset = nil
+      end
+
+      if attributes.key?(:'grain')
+        self.grain = attributes[:'grain']
+      end
+
+      if attributes.key?(:'object_type')
+        self.object_type = attributes[:'object_type']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'scope')
+        self.scope = attributes[:'scope']
+      end
+
+      if attributes.key?(:'columns')
+        if (value = attributes[:'columns']).is_a?(Array)
+          self.columns = value
+        end
+      else
+        self.columns = nil
+      end
+
+      if attributes.key?(:'rows')
+        if (value = attributes[:'rows']).is_a?(Array)
+          self.rows = value
+        end
+      else
+        self.rows = nil
+      end
+
+      if attributes.key?(:'total')
+        self.total = attributes[:'total']
+      end
+
+      if attributes.key?(:'next_cursor')
+        self.next_cursor = attributes[:'next_cursor']
+      end
+
+      if attributes.key?(:'sort')
+        if (value = attributes[:'sort']).is_a?(Array)
+          self.sort = value
+        end
+      end
+
+      if attributes.key?(:'filters')
+        if (value = attributes[:'filters']).is_a?(Array)
+          self.filters = value
+        end
+      end
+
+      if attributes.key?(:'group_by')
+        if (value = attributes[:'group_by']).is_a?(Array)
+          self.group_by = value
+        end
+      end
+
+      if attributes.key?(:'measures')
+        if (value = attributes[:'measures']).is_a?(Array)
+          self.measures = value
+        end
+      end
+
+      if attributes.key?(:'attribution')
+        if (value = attributes[:'attribution']).is_a?(Array)
+          self.attribution = value
+        end
+      end
+
+      if attributes.key?(:'source_credit')
+        self.source_credit = attributes[:'source_credit']
+      end
+
+      if attributes.key?(:'withheld_tiers')
+        if (value = attributes[:'withheld_tiers']).is_a?(Array)
+          self.withheld_tiers = value
+        end
+      end
+
+      if attributes.key?(:'withheld_columns')
+        if (value = attributes[:'withheld_columns']).is_a?(Array)
+          self.withheld_columns = value
+        end
+      end
+
+      if attributes.key?(:'freshness')
+        self.freshness = attributes[:'freshness']
+      end
+
+      if attributes.key?(:'build')
+        self.build = attributes[:'build']
+      end
+
+      if attributes.key?(:'build_state')
+        self.build_state = attributes[:'build_state']
+      end
+
+      if attributes.key?(:'restriction')
+        if (value = attributes[:'restriction']).is_a?(Hash)
+          self.restriction = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @dataset.nil?
+        invalid_properties.push('invalid value for "dataset", dataset cannot be nil.')
+      end
+
+      if @columns.nil?
+        invalid_properties.push('invalid value for "columns", columns cannot be nil.')
+      end
+
+      if @rows.nil?
+        invalid_properties.push('invalid value for "rows", rows cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @dataset.nil?
+      return false if @columns.nil?
+      return false if @rows.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] dataset Value to be assigned
+    def dataset=(dataset)
+      if dataset.nil?
+        fail ArgumentError, 'dataset cannot be nil'
+      end
+
+      @dataset = dataset
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] columns Value to be assigned
+    def columns=(columns)
+      if columns.nil?
+        fail ArgumentError, 'columns cannot be nil'
+      end
+
+      @columns = columns
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rows Value to be assigned
+    def rows=(rows)
+      if rows.nil?
+        fail ArgumentError, 'rows cannot be nil'
+      end
+
+      @rows = rows
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          dataset == o.dataset &&
+          grain == o.grain &&
+          object_type == o.object_type &&
+          id == o.id &&
+          scope == o.scope &&
+          columns == o.columns &&
+          rows == o.rows &&
+          total == o.total &&
+          next_cursor == o.next_cursor &&
+          sort == o.sort &&
+          filters == o.filters &&
+          group_by == o.group_by &&
+          measures == o.measures &&
+          attribution == o.attribution &&
+          source_credit == o.source_credit &&
+          withheld_tiers == o.withheld_tiers &&
+          withheld_columns == o.withheld_columns &&
+          freshness == o.freshness &&
+          build == o.build &&
+          build_state == o.build_state &&
+          restriction == o.restriction
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [dataset, grain, object_type, id, scope, columns, rows, total, next_cursor, sort, filters, group_by, measures, attribution, source_credit, withheld_tiers, withheld_columns, freshness, build, build_state, restriction].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = PharmaObservatory.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end