pharmaobservatory 0.1.2 → 0.1.3

data/lib/pharmaobservatory/models/{orgs_gxp_sites200_response_rows_inner.rb → sites_row.rb}

@@ -14,61 +14,87 @@ require 'date'
 require 'time'
 
 module PharmaObservatory
-  class OrgsGxpSites200ResponseRowsInner
-    attr_accessor :facility_name
+  # One row of the sites dataset: one row per site record (a facility as registered, not a physical building). A grouped request returns the group columns and the measures instead, as additional properties.
+  class SitesRow
+    # The site key: one facility spelling from the registry; the id the site page address carries.
+    attr_accessor :site_id
 
+    # The facility name as filed in the registry.
+    attr_accessor :site_name
+
+    # City as filed.
     attr_accessor :city
 
+    # State or province as filed.
+    attr_accessor :state
+
+    # Country name as filed.
     attr_accessor :country
 
-    attr_accessor :regulators
+    # Latitude of the finest coordinate the record has.
+    attr_accessor :latitude
 
-    attr_accessor :canonical_org_id
+    # Longitude of the finest coordinate the record has.
+    attr_accessor :longitude
 
-    attr_accessor :org_name
+    # How finely the coordinate places the site (city, postal and so on).
+    attr_accessor :geo_precision
 
-    attr_accessor :facility_key
+    # The source of the coordinate: aact (the registry's own), geonames (GeoNames) or als (Amazon Location Service).
+    attr_accessor :coord_source
 
-    attr_accessor :state_region
+    # True when the city the registry gave is a location that only the registry asserts for the institution.
+    attr_accessor :is_location_source_asserted_only
 
-    attr_accessor :severity_level
+    # Legal-entity level: the organization record the site's institution resolved to (null when unresolved).
+    attr_accessor :site_org_id
 
-    attr_accessor :severity_raw_verdict
+    # Company level: the company the site's institution belongs to (null when unresolved).
+    attr_accessor :site_company_id
 
-    attr_accessor :severity_signal_date
+    # Display name of the site's institution's company.
+    attr_accessor :site_company_name
 
-    attr_accessor :match_tier
+    # Group level: the site's institution's current ultimate parent company; a root company's group is itself.
+    attr_accessor :site_group_id
 
-    attr_accessor :restriction_tier
+    # Display name of the site's institution's group.
+    attr_accessor :site_group_name
 
-    attr_accessor :register_domain
+    # Registered trials that list the site.
+    attr_accessor :n_trials
 
-    attr_accessor :latitude
+    # Those trials whose status is ongoing.
+    attr_accessor :n_active
 
-    attr_accessor :longitude
+    # Year of the earliest trial start at the site.
+    attr_accessor :first_year
 
-    attr_accessor :geocode_precision
+    # Year of the latest trial start at the site.
+    attr_accessor :last_year
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'facility_name' => :'facility_name',
+        :'site_id' => :'site_id',
+        :'site_name' => :'site_name',
         :'city' => :'city',
+        :'state' => :'state',
         :'country' => :'country',
-        :'regulators' => :'regulators',
-        :'canonical_org_id' => :'canonical_org_id',
-        :'org_name' => :'org_name',
-        :'facility_key' => :'facility_key',
-        :'state_region' => :'state_region',
-        :'severity_level' => :'severity_level',
-        :'severity_raw_verdict' => :'severity_raw_verdict',
-        :'severity_signal_date' => :'severity_signal_date',
-        :'match_tier' => :'match_tier',
-        :'restriction_tier' => :'restriction_tier',
-        :'register_domain' => :'register_domain',
         :'latitude' => :'latitude',
         :'longitude' => :'longitude',
-        :'geocode_precision' => :'geocode_precision'
+        :'geo_precision' => :'geo_precision',
+        :'coord_source' => :'coord_source',
+        :'is_location_source_asserted_only' => :'is_location_source_asserted_only',
+        :'site_org_id' => :'site_org_id',
+        :'site_company_id' => :'site_company_id',
+        :'site_company_name' => :'site_company_name',
+        :'site_group_id' => :'site_group_id',
+        :'site_group_name' => :'site_group_name',
+        :'n_trials' => :'n_trials',
+        :'n_active' => :'n_active',
+        :'first_year' => :'first_year',
+        :'last_year' => :'last_year'
       }
     end
 
@@ -85,35 +111,50 @@ module PharmaObservatory
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'facility_name' => :'String',
+        :'site_id' => :'String',
+        :'site_name' => :'String',
         :'city' => :'String',
+        :'state' => :'String',
         :'country' => :'String',
-        :'regulators' => :'Array<String>',
-        :'canonical_org_id' => :'String',
-        :'org_name' => :'String',
-        :'facility_key' => :'String',
-        :'state_region' => :'Object',
-        :'severity_level' => :'String',
-        :'severity_raw_verdict' => :'String',
-        :'severity_signal_date' => :'String',
-        :'match_tier' => :'String',
-        :'restriction_tier' => :'String',
-        :'register_domain' => :'String',
-        :'latitude' => :'Object',
-        :'longitude' => :'Object',
-        :'geocode_precision' => :'Object'
+        :'latitude' => :'Float',
+        :'longitude' => :'Float',
+        :'geo_precision' => :'String',
+        :'coord_source' => :'String',
+        :'is_location_source_asserted_only' => :'Boolean',
+        :'site_org_id' => :'String',
+        :'site_company_id' => :'String',
+        :'site_company_name' => :'String',
+        :'site_group_id' => :'String',
+        :'site_group_name' => :'String',
+        :'n_trials' => :'Integer',
+        :'n_active' => :'Integer',
+        :'first_year' => :'Integer',
+        :'last_year' => :'Integer'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'state_region',
-        :'severity_raw_verdict',
-        :'severity_signal_date',
+        :'site_id',
+        :'site_name',
+        :'city',
+        :'state',
+        :'country',
         :'latitude',
         :'longitude',
-        :'geocode_precision'
+        :'geo_precision',
+        :'coord_source',
+        :'is_location_source_asserted_only',
+        :'site_org_id',
+        :'site_company_id',
+        :'site_company_name',
+        :'site_group_id',
+        :'site_group_name',
+        :'n_trials',
+        :'n_active',
+        :'first_year',
+        :'last_year'
       ])
     end
 
@@ -121,98 +162,92 @@ 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::OrgsGxpSites200ResponseRowsInner` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PharmaObservatory::SitesRow` 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::OrgsGxpSites200ResponseRowsInner`. 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::SitesRow`. 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?(:'facility_name')
-        self.facility_name = attributes[:'facility_name']
-      else
-        self.facility_name = nil
+      if attributes.key?(:'site_id')
+        self.site_id = attributes[:'site_id']
+      end
+
+      if attributes.key?(:'site_name')
+        self.site_name = attributes[:'site_name']
       end
 
       if attributes.key?(:'city')
         self.city = attributes[:'city']
-      else
-        self.city = nil
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
       end
 
       if attributes.key?(:'country')
         self.country = attributes[:'country']
-      else
-        self.country = nil
       end
 
-      if attributes.key?(:'regulators')
-        if (value = attributes[:'regulators']).is_a?(Array)
-          self.regulators = value
-        end
-      else
-        self.regulators = nil
+      if attributes.key?(:'latitude')
+        self.latitude = attributes[:'latitude']
       end
 
-      if attributes.key?(:'canonical_org_id')
-        self.canonical_org_id = attributes[:'canonical_org_id']
-      else
-        self.canonical_org_id = nil
+      if attributes.key?(:'longitude')
+        self.longitude = attributes[:'longitude']
       end
 
-      if attributes.key?(:'org_name')
-        self.org_name = attributes[:'org_name']
-      else
-        self.org_name = nil
+      if attributes.key?(:'geo_precision')
+        self.geo_precision = attributes[:'geo_precision']
       end
 
-      if attributes.key?(:'facility_key')
-        self.facility_key = attributes[:'facility_key']
+      if attributes.key?(:'coord_source')
+        self.coord_source = attributes[:'coord_source']
       end
 
-      if attributes.key?(:'state_region')
-        self.state_region = attributes[:'state_region']
+      if attributes.key?(:'is_location_source_asserted_only')
+        self.is_location_source_asserted_only = attributes[:'is_location_source_asserted_only']
       end
 
-      if attributes.key?(:'severity_level')
-        self.severity_level = attributes[:'severity_level']
+      if attributes.key?(:'site_org_id')
+        self.site_org_id = attributes[:'site_org_id']
       end
 
-      if attributes.key?(:'severity_raw_verdict')
-        self.severity_raw_verdict = attributes[:'severity_raw_verdict']
+      if attributes.key?(:'site_company_id')
+        self.site_company_id = attributes[:'site_company_id']
       end
 
-      if attributes.key?(:'severity_signal_date')
-        self.severity_signal_date = attributes[:'severity_signal_date']
+      if attributes.key?(:'site_company_name')
+        self.site_company_name = attributes[:'site_company_name']
       end
 
-      if attributes.key?(:'match_tier')
-        self.match_tier = attributes[:'match_tier']
+      if attributes.key?(:'site_group_id')
+        self.site_group_id = attributes[:'site_group_id']
       end
 
-      if attributes.key?(:'restriction_tier')
-        self.restriction_tier = attributes[:'restriction_tier']
+      if attributes.key?(:'site_group_name')
+        self.site_group_name = attributes[:'site_group_name']
       end
 
-      if attributes.key?(:'register_domain')
-        self.register_domain = attributes[:'register_domain']
+      if attributes.key?(:'n_trials')
+        self.n_trials = attributes[:'n_trials']
       end
 
-      if attributes.key?(:'latitude')
-        self.latitude = attributes[:'latitude']
+      if attributes.key?(:'n_active')
+        self.n_active = attributes[:'n_active']
       end
 
-      if attributes.key?(:'longitude')
-        self.longitude = attributes[:'longitude']
+      if attributes.key?(:'first_year')
+        self.first_year = attributes[:'first_year']
       end
 
-      if attributes.key?(:'geocode_precision')
-        self.geocode_precision = attributes[:'geocode_precision']
+      if attributes.key?(:'last_year')
+        self.last_year = attributes[:'last_year']
       end
     end
 
@@ -221,30 +256,6 @@ module PharmaObservatory
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @facility_name.nil?
-        invalid_properties.push('invalid value for "facility_name", facility_name cannot be nil.')
-      end
-
-      if @city.nil?
-        invalid_properties.push('invalid value for "city", city cannot be nil.')
-      end
-
-      if @country.nil?
-        invalid_properties.push('invalid value for "country", country cannot be nil.')
-      end
-
-      if @regulators.nil?
-        invalid_properties.push('invalid value for "regulators", regulators cannot be nil.')
-      end
-
-      if @canonical_org_id.nil?
-        invalid_properties.push('invalid value for "canonical_org_id", canonical_org_id cannot be nil.')
-      end
-
-      if @org_name.nil?
-        invalid_properties.push('invalid value for "org_name", org_name cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -252,97 +263,33 @@ module PharmaObservatory
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @facility_name.nil?
-      return false if @city.nil?
-      return false if @country.nil?
-      return false if @regulators.nil?
-      return false if @canonical_org_id.nil?
-      return false if @org_name.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] facility_name Value to be assigned
-    def facility_name=(facility_name)
-      if facility_name.nil?
-        fail ArgumentError, 'facility_name cannot be nil'
-      end
-
-      @facility_name = facility_name
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] city Value to be assigned
-    def city=(city)
-      if city.nil?
-        fail ArgumentError, 'city cannot be nil'
-      end
-
-      @city = city
-    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] regulators Value to be assigned
-    def regulators=(regulators)
-      if regulators.nil?
-        fail ArgumentError, 'regulators cannot be nil'
-      end
-
-      @regulators = regulators
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] canonical_org_id Value to be assigned
-    def canonical_org_id=(canonical_org_id)
-      if canonical_org_id.nil?
-        fail ArgumentError, 'canonical_org_id cannot be nil'
-      end
-
-      @canonical_org_id = canonical_org_id
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] org_name Value to be assigned
-    def org_name=(org_name)
-      if org_name.nil?
-        fail ArgumentError, 'org_name cannot be nil'
-      end
-
-      @org_name = org_name
-    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 &&
-          facility_name == o.facility_name &&
+          site_id == o.site_id &&
+          site_name == o.site_name &&
           city == o.city &&
+          state == o.state &&
           country == o.country &&
-          regulators == o.regulators &&
-          canonical_org_id == o.canonical_org_id &&
-          org_name == o.org_name &&
-          facility_key == o.facility_key &&
-          state_region == o.state_region &&
-          severity_level == o.severity_level &&
-          severity_raw_verdict == o.severity_raw_verdict &&
-          severity_signal_date == o.severity_signal_date &&
-          match_tier == o.match_tier &&
-          restriction_tier == o.restriction_tier &&
-          register_domain == o.register_domain &&
           latitude == o.latitude &&
           longitude == o.longitude &&
-          geocode_precision == o.geocode_precision
+          geo_precision == o.geo_precision &&
+          coord_source == o.coord_source &&
+          is_location_source_asserted_only == o.is_location_source_asserted_only &&
+          site_org_id == o.site_org_id &&
+          site_company_id == o.site_company_id &&
+          site_company_name == o.site_company_name &&
+          site_group_id == o.site_group_id &&
+          site_group_name == o.site_group_name &&
+          n_trials == o.n_trials &&
+          n_active == o.n_active &&
+          first_year == o.first_year &&
+          last_year == o.last_year
     end
 
     # @see the `==` method
@@ -354,7 +301,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [facility_name, city, country, regulators, canonical_org_id, org_name, facility_key, state_region, severity_level, severity_raw_verdict, severity_signal_date, match_tier, restriction_tier, register_domain, latitude, longitude, geocode_precision].hash
+      [site_id, site_name, city, state, country, latitude, longitude, geo_precision, coord_source, is_location_source_asserted_only, site_org_id, site_company_id, site_company_name, site_group_id, site_group_name, n_trials, n_active, first_year, last_year].hash
     end
 
     # Builds the object from hash