pharmaobservatory 0.1.2 → 0.1.3

data/lib/pharmaobservatory/models/{orgs_group_structure200_response_rows_inner.rb → legal_entities_row.rb}

@@ -14,40 +14,91 @@ require 'date'
 require 'time'
 
 module PharmaObservatory
-  class OrgsGroupStructure200ResponseRowsInner
-    attr_accessor :entity_id
+  # One row of the legal_entities dataset: one row per organization record (a registered legal entity or a name-resolved sponsor). A grouped request returns the group columns and the measures instead, as additional properties.
+  class LegalEntitiesRow
+    # The organization record id: a registered legal entity (edgar:, ror:) or a name-resolved sponsor (sponsor:).
+    attr_accessor :org_id
 
-    attr_accessor :name
+    # The organization's name.
+    attr_accessor :org_name
 
+    # True for a sponsor resolved from a filed name alone rather than from a registration.
+    attr_accessor :is_name_resolved_sponsor
+
+    # How the organization record was minted.
+    attr_accessor :org_origin
+
+    # Country as the source states it.
     attr_accessor :country
 
-    attr_accessor :canonical_org_id
+    # Organization type.
+    attr_accessor :org_type
 
-    attr_accessor :company_id
+    # SEC EDGAR central index key, when it files.
+    attr_accessor :edgar_cik
+
+    # Exchange ticker, when listed.
+    attr_accessor :edgar_ticker
+
+    # Research Organization Registry id, when it has one.
+    attr_accessor :ror_id
+
+    # Legal Entity Identifier, when it has one.
+    attr_accessor :lei
+
+    # Lifecycle status from the registry sources.
+    attr_accessor :lifecycle_status
+
+    # Trials the organization leads.
+    attr_accessor :num_lead_trials
+
+    # Trials the organization leads or collaborates on.
+    attr_accessor :num_trials
 
-    attr_accessor :lead_trials
+    # Planned enrollment across led trials.
+    attr_accessor :total_lead_enrollment
 
-    attr_accessor :parent_id
+    # Led trials started in the recent window.
+    attr_accessor :num_recent_lead_trials
 
-    attr_accessor :link
+    # Trial activity score.
+    attr_accessor :activity_score
 
-    attr_accessor :link_source
+    # Company level: the company the organization belongs to (null when unresolved).
+    attr_accessor :company_id
+
+    # Display name of the company.
+    attr_accessor :company_name
+
+    # Group level: the company's current ultimate parent; a root's group is itself.
+    attr_accessor :group_id
 
-    attr_accessor :is_this_entity
+    # Display name of the group.
+    attr_accessor :group_name
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'entity_id' => :'entity_id',
-        :'name' => :'name',
+        :'org_id' => :'org_id',
+        :'org_name' => :'org_name',
+        :'is_name_resolved_sponsor' => :'is_name_resolved_sponsor',
+        :'org_origin' => :'org_origin',
         :'country' => :'country',
-        :'canonical_org_id' => :'canonical_org_id',
+        :'org_type' => :'org_type',
+        :'edgar_cik' => :'edgar_cik',
+        :'edgar_ticker' => :'edgar_ticker',
+        :'ror_id' => :'ror_id',
+        :'lei' => :'lei',
+        :'lifecycle_status' => :'lifecycle_status',
+        :'num_lead_trials' => :'num_lead_trials',
+        :'num_trials' => :'num_trials',
+        :'total_lead_enrollment' => :'total_lead_enrollment',
+        :'num_recent_lead_trials' => :'num_recent_lead_trials',
+        :'activity_score' => :'activity_score',
         :'company_id' => :'company_id',
-        :'lead_trials' => :'lead_trials',
-        :'parent_id' => :'parent_id',
-        :'link' => :'link',
-        :'link_source' => :'link_source',
-        :'is_this_entity' => :'is_this_entity'
+        :'company_name' => :'company_name',
+        :'group_id' => :'group_id',
+        :'group_name' => :'group_name'
       }
     end
 
@@ -64,25 +115,52 @@ module PharmaObservatory
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'entity_id' => :'String',
-        :'name' => :'String',
+        :'org_id' => :'String',
+        :'org_name' => :'String',
+        :'is_name_resolved_sponsor' => :'Boolean',
+        :'org_origin' => :'String',
         :'country' => :'String',
-        :'canonical_org_id' => :'String',
+        :'org_type' => :'String',
+        :'edgar_cik' => :'String',
+        :'edgar_ticker' => :'String',
+        :'ror_id' => :'String',
+        :'lei' => :'String',
+        :'lifecycle_status' => :'String',
+        :'num_lead_trials' => :'Integer',
+        :'num_trials' => :'Integer',
+        :'total_lead_enrollment' => :'Float',
+        :'num_recent_lead_trials' => :'Integer',
+        :'activity_score' => :'Float',
         :'company_id' => :'String',
-        :'lead_trials' => :'Integer',
-        :'parent_id' => :'String',
-        :'link' => :'String',
-        :'link_source' => :'String',
-        :'is_this_entity' => :'Boolean'
+        :'company_name' => :'String',
+        :'group_id' => :'String',
+        :'group_name' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'canonical_org_id',
-        :'parent_id',
-        :'link_source',
+        :'org_id',
+        :'org_name',
+        :'is_name_resolved_sponsor',
+        :'org_origin',
+        :'country',
+        :'org_type',
+        :'edgar_cik',
+        :'edgar_ticker',
+        :'ror_id',
+        :'lei',
+        :'lifecycle_status',
+        :'num_lead_trials',
+        :'num_trials',
+        :'total_lead_enrollment',
+        :'num_recent_lead_trials',
+        :'activity_score',
+        :'company_id',
+        :'company_name',
+        :'group_id',
+        :'group_name'
       ])
     end
 
@@ -90,112 +168,104 @@ module PharmaObservatory
     # @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::OrgsGroupStructure200ResponseRowsInner` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PharmaObservatory::LegalEntitiesRow` 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::OrgsGroupStructure200ResponseRowsInner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PharmaObservatory::LegalEntitiesRow`. 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?(:'entity_id')
-        self.entity_id = attributes[:'entity_id']
-      else
-        self.entity_id = nil
+      if attributes.key?(:'org_id')
+        self.org_id = attributes[:'org_id']
       end
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
-      else
-        self.name = nil
+      if attributes.key?(:'org_name')
+        self.org_name = attributes[:'org_name']
+      end
+
+      if attributes.key?(:'is_name_resolved_sponsor')
+        self.is_name_resolved_sponsor = attributes[:'is_name_resolved_sponsor']
+      end
+
+      if attributes.key?(:'org_origin')
+        self.org_origin = attributes[:'org_origin']
       end
 
       if attributes.key?(:'country')
         self.country = attributes[:'country']
-      else
-        self.country = nil
       end
 
-      if attributes.key?(:'canonical_org_id')
-        self.canonical_org_id = attributes[:'canonical_org_id']
-      else
-        self.canonical_org_id = nil
+      if attributes.key?(:'org_type')
+        self.org_type = attributes[:'org_type']
       end
 
-      if attributes.key?(:'company_id')
-        self.company_id = attributes[:'company_id']
-      else
-        self.company_id = nil
+      if attributes.key?(:'edgar_cik')
+        self.edgar_cik = attributes[:'edgar_cik']
       end
 
-      if attributes.key?(:'lead_trials')
-        self.lead_trials = attributes[:'lead_trials']
-      else
-        self.lead_trials = nil
+      if attributes.key?(:'edgar_ticker')
+        self.edgar_ticker = attributes[:'edgar_ticker']
       end
 
-      if attributes.key?(:'parent_id')
-        self.parent_id = attributes[:'parent_id']
-      else
-        self.parent_id = nil
+      if attributes.key?(:'ror_id')
+        self.ror_id = attributes[:'ror_id']
       end
 
-      if attributes.key?(:'link')
-        self.link = attributes[:'link']
-      else
-        self.link = nil
+      if attributes.key?(:'lei')
+        self.lei = attributes[:'lei']
       end
 
-      if attributes.key?(:'link_source')
-        self.link_source = attributes[:'link_source']
-      else
-        self.link_source = nil
+      if attributes.key?(:'lifecycle_status')
+        self.lifecycle_status = attributes[:'lifecycle_status']
       end
 
-      if attributes.key?(:'is_this_entity')
-        self.is_this_entity = attributes[:'is_this_entity']
-      else
-        self.is_this_entity = nil
+      if attributes.key?(:'num_lead_trials')
+        self.num_lead_trials = attributes[:'num_lead_trials']
       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 @entity_id.nil?
-        invalid_properties.push('invalid value for "entity_id", entity_id cannot be nil.')
+      if attributes.key?(:'num_trials')
+        self.num_trials = attributes[:'num_trials']
+      end
+
+      if attributes.key?(:'total_lead_enrollment')
+        self.total_lead_enrollment = attributes[:'total_lead_enrollment']
       end
 
-      if @name.nil?
-        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      if attributes.key?(:'num_recent_lead_trials')
+        self.num_recent_lead_trials = attributes[:'num_recent_lead_trials']
       end
 
-      if @country.nil?
-        invalid_properties.push('invalid value for "country", country cannot be nil.')
+      if attributes.key?(:'activity_score')
+        self.activity_score = attributes[:'activity_score']
       end
 
-      if @company_id.nil?
-        invalid_properties.push('invalid value for "company_id", company_id cannot be nil.')
+      if attributes.key?(:'company_id')
+        self.company_id = attributes[:'company_id']
       end
 
-      if @lead_trials.nil?
-        invalid_properties.push('invalid value for "lead_trials", lead_trials cannot be nil.')
+      if attributes.key?(:'company_name')
+        self.company_name = attributes[:'company_name']
       end
 
-      if @link.nil?
-        invalid_properties.push('invalid value for "link", link cannot be nil.')
+      if attributes.key?(:'group_id')
+        self.group_id = attributes[:'group_id']
       end
 
-      if @is_this_entity.nil?
-        invalid_properties.push('invalid value for "is_this_entity", is_this_entity cannot be nil.')
+      if attributes.key?(:'group_name')
+        self.group_name = attributes[:'group_name']
       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
       invalid_properties
     end
 
@@ -203,101 +273,34 @@ module PharmaObservatory
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @entity_id.nil?
-      return false if @name.nil?
-      return false if @country.nil?
-      return false if @company_id.nil?
-      return false if @lead_trials.nil?
-      return false if @link.nil?
-      return false if @is_this_entity.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] entity_id Value to be assigned
-    def entity_id=(entity_id)
-      if entity_id.nil?
-        fail ArgumentError, 'entity_id cannot be nil'
-      end
-
-      @entity_id = entity_id
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] name Value to be assigned
-    def name=(name)
-      if name.nil?
-        fail ArgumentError, 'name cannot be nil'
-      end
-
-      @name = name
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] country Value to be assigned
-    def country=(country)
-      if country.nil?
-        fail ArgumentError, 'country cannot be nil'
-      end
-
-      @country = country
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] company_id Value to be assigned
-    def company_id=(company_id)
-      if company_id.nil?
-        fail ArgumentError, 'company_id cannot be nil'
-      end
-
-      @company_id = company_id
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] lead_trials Value to be assigned
-    def lead_trials=(lead_trials)
-      if lead_trials.nil?
-        fail ArgumentError, 'lead_trials cannot be nil'
-      end
-
-      @lead_trials = lead_trials
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] link Value to be assigned
-    def link=(link)
-      if link.nil?
-        fail ArgumentError, 'link cannot be nil'
-      end
-
-      @link = link
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] is_this_entity Value to be assigned
-    def is_this_entity=(is_this_entity)
-      if is_this_entity.nil?
-        fail ArgumentError, 'is_this_entity cannot be nil'
-      end
-
-      @is_this_entity = is_this_entity
-    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 &&
-          entity_id == o.entity_id &&
-          name == o.name &&
+          org_id == o.org_id &&
+          org_name == o.org_name &&
+          is_name_resolved_sponsor == o.is_name_resolved_sponsor &&
+          org_origin == o.org_origin &&
           country == o.country &&
-          canonical_org_id == o.canonical_org_id &&
+          org_type == o.org_type &&
+          edgar_cik == o.edgar_cik &&
+          edgar_ticker == o.edgar_ticker &&
+          ror_id == o.ror_id &&
+          lei == o.lei &&
+          lifecycle_status == o.lifecycle_status &&
+          num_lead_trials == o.num_lead_trials &&
+          num_trials == o.num_trials &&
+          total_lead_enrollment == o.total_lead_enrollment &&
+          num_recent_lead_trials == o.num_recent_lead_trials &&
+          activity_score == o.activity_score &&
           company_id == o.company_id &&
-          lead_trials == o.lead_trials &&
-          parent_id == o.parent_id &&
-          link == o.link &&
-          link_source == o.link_source &&
-          is_this_entity == o.is_this_entity
+          company_name == o.company_name &&
+          group_id == o.group_id &&
+          group_name == o.group_name
     end
 
     # @see the `==` method
@@ -309,7 +312,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [entity_id, name, country, canonical_org_id, company_id, lead_trials, parent_id, link, link_source, is_this_entity].hash
+      [org_id, org_name, is_name_resolved_sponsor, org_origin, country, org_type, edgar_cik, edgar_ticker, ror_id, lei, lifecycle_status, num_lead_trials, num_trials, total_lead_enrollment, num_recent_lead_trials, activity_score, company_id, company_name, group_id, group_name].hash
     end
 
     # Builds the object from hash