pharmaobservatory 0.1.1 → 0.1.3

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

@@ -14,55 +14,87 @@ require 'date'
 require 'time'
 
 module PharmaObservatory
-  class ApiV1SiteRecordGet200ResponseSitesInner
-    attr_accessor :site_key
+  # 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
 
-    attr_accessor :facility_name
+    # 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 :n_trials
+    # Latitude of the finest coordinate the record has.
+    attr_accessor :latitude
 
-    attr_accessor :n_active
+    # Longitude of the finest coordinate the record has.
+    attr_accessor :longitude
 
-    attr_accessor :active_years
+    # How finely the coordinate places the site (city, postal and so on).
+    attr_accessor :geo_precision
 
-    attr_accessor :latitude
+    # The source of the coordinate: aact (the registry's own), geonames (GeoNames) or als (Amazon Location Service).
+    attr_accessor :coord_source
 
-    attr_accessor :longitude
+    # 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 :trials
+    # Legal-entity level: the organization record the site's institution resolved to (null when unresolved).
+    attr_accessor :site_org_id
 
-    attr_accessor :indications
+    # Company level: the company the site's institution belongs to (null when unresolved).
+    attr_accessor :site_company_id
+
+    # Display name of the site's institution's company.
+    attr_accessor :site_company_name
+
+    # Group level: the site's institution's current ultimate parent company; a root company's group is itself.
+    attr_accessor :site_group_id
+
+    # Display name of the site's institution's group.
+    attr_accessor :site_group_name
+
+    # Registered trials that list the site.
+    attr_accessor :n_trials
 
-    attr_accessor :drugs
+    # Those trials whose status is ongoing.
+    attr_accessor :n_active
 
-    attr_accessor :estimated_enrollment
+    # Year of the earliest trial start at the site.
+    attr_accessor :first_year
 
-    attr_accessor :investigators
+    # 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
       {
-        :'site_key' => :'site_key',
-        :'facility_name' => :'facility_name',
+        :'site_id' => :'site_id',
+        :'site_name' => :'site_name',
         :'city' => :'city',
         :'state' => :'state',
         :'country' => :'country',
-        :'n_trials' => :'n_trials',
-        :'n_active' => :'n_active',
-        :'active_years' => :'active_years',
         :'latitude' => :'latitude',
         :'longitude' => :'longitude',
-        :'trials' => :'trials',
-        :'indications' => :'indications',
-        :'drugs' => :'drugs',
-        :'estimated_enrollment' => :'estimated_enrollment',
-        :'investigators' => :'investigators'
+        :'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
 
@@ -79,29 +111,50 @@ module PharmaObservatory
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'site_key' => :'String',
-        :'facility_name' => :'String',
+        :'site_id' => :'String',
+        :'site_name' => :'String',
         :'city' => :'String',
         :'state' => :'String',
         :'country' => :'String',
+        :'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',
-        :'active_years' => :'ApiV1SiteRecordGet200ResponseSitesInnerActiveYears',
-        :'latitude' => :'String',
-        :'longitude' => :'String',
-        :'trials' => :'Array<ApiV1SiteRecordGet200ResponseSitesInnerTrialsInner>',
-        :'indications' => :'Array<ApiV1SiteRecordGet200ResponseSitesInnerIndicationsInner>',
-        :'drugs' => :'Array<ApiV1SiteRecordGet200ResponseSitesInnerDrugsInner>',
-        :'estimated_enrollment' => :'ApiV1SiteRecordGet200ResponseSitesInnerEstimatedEnrollment',
-        :'investigators' => :'Array<ApiV1SiteRecordGet200ResponseSitesInnerInvestigatorsInner>'
+        :'first_year' => :'Integer',
+        :'last_year' => :'Integer'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'site_id',
+        :'site_name',
+        :'city',
         :'state',
-        :'estimated_enrollment',
+        :'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'
       ])
     end
 
@@ -109,64 +162,36 @@ 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::ApiV1SiteRecordGet200ResponseSitesInner` 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::ApiV1SiteRecordGet200ResponseSitesInner`. 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?(:'site_key')
-        self.site_key = attributes[:'site_key']
-      else
-        self.site_key = nil
+      if attributes.key?(:'site_id')
+        self.site_id = attributes[:'site_id']
       end
 
-      if attributes.key?(:'facility_name')
-        self.facility_name = attributes[:'facility_name']
-      else
-        self.facility_name = nil
+      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']
-      else
-        self.state = nil
       end
 
       if attributes.key?(:'country')
         self.country = attributes[:'country']
-      else
-        self.country = nil
-      end
-
-      if attributes.key?(:'n_trials')
-        self.n_trials = attributes[:'n_trials']
-      else
-        self.n_trials = nil
-      end
-
-      if attributes.key?(:'n_active')
-        self.n_active = attributes[:'n_active']
-      else
-        self.n_active = nil
-      end
-
-      if attributes.key?(:'active_years')
-        self.active_years = attributes[:'active_years']
-      else
-        self.active_years = nil
       end
 
       if attributes.key?(:'latitude')
@@ -177,68 +202,60 @@ module PharmaObservatory
         self.longitude = attributes[:'longitude']
       end
 
-      if attributes.key?(:'trials')
-        if (value = attributes[:'trials']).is_a?(Array)
-          self.trials = value
-        end
+      if attributes.key?(:'geo_precision')
+        self.geo_precision = attributes[:'geo_precision']
       end
 
-      if attributes.key?(:'indications')
-        if (value = attributes[:'indications']).is_a?(Array)
-          self.indications = value
-        end
+      if attributes.key?(:'coord_source')
+        self.coord_source = attributes[:'coord_source']
       end
 
-      if attributes.key?(:'drugs')
-        if (value = attributes[:'drugs']).is_a?(Array)
-          self.drugs = value
-        end
+      if attributes.key?(:'is_location_source_asserted_only')
+        self.is_location_source_asserted_only = attributes[:'is_location_source_asserted_only']
       end
 
-      if attributes.key?(:'estimated_enrollment')
-        self.estimated_enrollment = attributes[:'estimated_enrollment']
+      if attributes.key?(:'site_org_id')
+        self.site_org_id = attributes[:'site_org_id']
       end
 
-      if attributes.key?(:'investigators')
-        if (value = attributes[:'investigators']).is_a?(Array)
-          self.investigators = value
-        end
+      if attributes.key?(:'site_company_id')
+        self.site_company_id = attributes[:'site_company_id']
       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 @site_key.nil?
-        invalid_properties.push('invalid value for "site_key", site_key cannot be nil.')
+      if attributes.key?(:'site_company_name')
+        self.site_company_name = attributes[:'site_company_name']
       end
 
-      if @facility_name.nil?
-        invalid_properties.push('invalid value for "facility_name", facility_name cannot be nil.')
+      if attributes.key?(:'site_group_id')
+        self.site_group_id = attributes[:'site_group_id']
       end
 
-      if @city.nil?
-        invalid_properties.push('invalid value for "city", city cannot be nil.')
+      if attributes.key?(:'site_group_name')
+        self.site_group_name = attributes[:'site_group_name']
       end
 
-      if @country.nil?
-        invalid_properties.push('invalid value for "country", country cannot be nil.')
+      if attributes.key?(:'n_trials')
+        self.n_trials = attributes[:'n_trials']
       end
 
-      if @n_trials.nil?
-        invalid_properties.push('invalid value for "n_trials", n_trials cannot be nil.')
+      if attributes.key?(:'n_active')
+        self.n_active = attributes[:'n_active']
       end
 
-      if @n_active.nil?
-        invalid_properties.push('invalid value for "n_active", n_active cannot be nil.')
+      if attributes.key?(:'first_year')
+        self.first_year = attributes[:'first_year']
       end
 
-      if @active_years.nil?
-        invalid_properties.push('invalid value for "active_years", active_years cannot be nil.')
+      if attributes.key?(:'last_year')
+        self.last_year = attributes[:'last_year']
       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
 
@@ -246,106 +263,33 @@ module PharmaObservatory
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @site_key.nil?
-      return false if @facility_name.nil?
-      return false if @city.nil?
-      return false if @country.nil?
-      return false if @n_trials.nil?
-      return false if @n_active.nil?
-      return false if @active_years.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] site_key Value to be assigned
-    def site_key=(site_key)
-      if site_key.nil?
-        fail ArgumentError, 'site_key cannot be nil'
-      end
-
-      @site_key = site_key
-    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] n_trials Value to be assigned
-    def n_trials=(n_trials)
-      if n_trials.nil?
-        fail ArgumentError, 'n_trials cannot be nil'
-      end
-
-      @n_trials = n_trials
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] n_active Value to be assigned
-    def n_active=(n_active)
-      if n_active.nil?
-        fail ArgumentError, 'n_active cannot be nil'
-      end
-
-      @n_active = n_active
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] active_years Value to be assigned
-    def active_years=(active_years)
-      if active_years.nil?
-        fail ArgumentError, 'active_years cannot be nil'
-      end
-
-      @active_years = active_years
-    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 &&
-          site_key == o.site_key &&
-          facility_name == o.facility_name &&
+          site_id == o.site_id &&
+          site_name == o.site_name &&
           city == o.city &&
           state == o.state &&
           country == o.country &&
-          n_trials == o.n_trials &&
-          n_active == o.n_active &&
-          active_years == o.active_years &&
           latitude == o.latitude &&
           longitude == o.longitude &&
-          trials == o.trials &&
-          indications == o.indications &&
-          drugs == o.drugs &&
-          estimated_enrollment == o.estimated_enrollment &&
-          investigators == o.investigators
+          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
@@ -357,7 +301,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [site_key, facility_name, city, state, country, n_trials, n_active, active_years, latitude, longitude, trials, indications, drugs, estimated_enrollment, investigators].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