pharmaobservatory 0.1.2 → 0.1.3

data/lib/pharmaobservatory/models/{orgs_patent_cliff200_response_rows_inner.rb → drug_patent_cliff_row.rb}

@@ -14,40 +14,115 @@ require 'date'
 require 'time'
 
 module PharmaObservatory
-  class OrgsPatentCliff200ResponseRowsInner
-    attr_accessor :canonical_drug_id
+  # One row of the drug_patent_cliff dataset: one row per drug whose exclusivity ends in the future. A grouped request returns the group columns and the measures instead, as additional properties.
+  class DrugPatentCliffRow
+    # The drug key.
+    attr_accessor :drug_id
 
+    # The drug's name.
     attr_accessor :drug_name
 
-    attr_accessor :cliff_year
+    # The drug's pharmacologic class.
+    attr_accessor :pharm_class
+
+    # The drug's ATC class.
+    attr_accessor :atc_class
+
+    # The brand name.
+    attr_accessor :brand
+
+    # Other candidate brand names, comma separated.
+    attr_accessor :candidate_brands
 
+    # The date exclusivity is expected to end (loss of exclusivity); always in the future when the dataset is built.
     attr_accessor :cliff_date
 
+    # The year of cliff_date.
+    attr_accessor :cliff_year
+
+    # Which regime set the date: curated_loe, orange_book_patent, pte_expiry or bpcia_exclusivity.
     attr_accessor :cliff_basis
 
+    # Source of a curated date (null on the other bases).
     attr_accessor :cliff_source
 
+    # Confidence of a curated date (null on the other bases).
     attr_accessor :cliff_confidence
 
-    attr_accessor :medicare_spend
-
+    # True when a generic is already marketed.
     attr_accessor :has_generic
 
+    # True when a biosimilar is already marketed.
     attr_accessor :biosimilar_available
 
+    # The brand or originator applicant as the Orange Book or Purple Book names it.
+    attr_accessor :applicant_name
+
+    # Legal-entity level: the organization record the applicant resolved to (null when unresolved).
+    attr_accessor :applicant_org_id
+
+    # Company level: the company the applicant belongs to (null when unresolved).
+    attr_accessor :applicant_company_id
+
+    # Display name of the applicant's company.
+    attr_accessor :applicant_company_name
+
+    # Group level: the applicant's current ultimate parent company; a root company's group is itself.
+    attr_accessor :applicant_group_id
+
+    # Display name of the applicant's group.
+    attr_accessor :applicant_group_name
+
+    # How the applicant name matched an organization record.
+    attr_accessor :applicant_match_scope
+
+    # Latest-year Medicare Part B and D spend for the drug, in US dollars.
+    attr_accessor :medicare_spend
+
+    # The year of medicare_spend.
+    attr_accessor :medicare_spend_year
+
+    # Latest full-year disclosed worldwide revenue, in US millions.
+    attr_accessor :disclosed_revenue_usd_millions
+
+    # The fiscal year of the disclosed revenue.
+    attr_accessor :disclosed_revenue_year
+
+    # The single size axis in US dollars: disclosed revenue when present, else Medicare spend.
+    attr_accessor :size_usd
+
+    # Which source size_usd used: disclosed_worldwide_revenue, medicare_spend or none.
+    attr_accessor :size_basis
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'canonical_drug_id' => :'canonical_drug_id',
+        :'drug_id' => :'drug_id',
         :'drug_name' => :'drug_name',
-        :'cliff_year' => :'cliff_year',
+        :'pharm_class' => :'pharm_class',
+        :'atc_class' => :'atc_class',
+        :'brand' => :'brand',
+        :'candidate_brands' => :'candidate_brands',
         :'cliff_date' => :'cliff_date',
+        :'cliff_year' => :'cliff_year',
         :'cliff_basis' => :'cliff_basis',
         :'cliff_source' => :'cliff_source',
         :'cliff_confidence' => :'cliff_confidence',
-        :'medicare_spend' => :'medicare_spend',
         :'has_generic' => :'has_generic',
-        :'biosimilar_available' => :'biosimilar_available'
+        :'biosimilar_available' => :'biosimilar_available',
+        :'applicant_name' => :'applicant_name',
+        :'applicant_org_id' => :'applicant_org_id',
+        :'applicant_company_id' => :'applicant_company_id',
+        :'applicant_company_name' => :'applicant_company_name',
+        :'applicant_group_id' => :'applicant_group_id',
+        :'applicant_group_name' => :'applicant_group_name',
+        :'applicant_match_scope' => :'applicant_match_scope',
+        :'medicare_spend' => :'medicare_spend',
+        :'medicare_spend_year' => :'medicare_spend_year',
+        :'disclosed_revenue_usd_millions' => :'disclosed_revenue_usd_millions',
+        :'disclosed_revenue_year' => :'disclosed_revenue_year',
+        :'size_usd' => :'size_usd',
+        :'size_basis' => :'size_basis'
       }
     end
 
@@ -64,25 +139,64 @@ module PharmaObservatory
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'canonical_drug_id' => :'String',
+        :'drug_id' => :'String',
         :'drug_name' => :'String',
+        :'pharm_class' => :'String',
+        :'atc_class' => :'String',
+        :'brand' => :'String',
+        :'candidate_brands' => :'String',
+        :'cliff_date' => :'Date',
         :'cliff_year' => :'Integer',
-        :'cliff_date' => :'String',
         :'cliff_basis' => :'String',
-        :'cliff_source' => :'Object',
-        :'cliff_confidence' => :'Object',
-        :'medicare_spend' => :'Object',
+        :'cliff_source' => :'String',
+        :'cliff_confidence' => :'String',
         :'has_generic' => :'Boolean',
-        :'biosimilar_available' => :'Boolean'
+        :'biosimilar_available' => :'Boolean',
+        :'applicant_name' => :'String',
+        :'applicant_org_id' => :'String',
+        :'applicant_company_id' => :'String',
+        :'applicant_company_name' => :'String',
+        :'applicant_group_id' => :'String',
+        :'applicant_group_name' => :'String',
+        :'applicant_match_scope' => :'String',
+        :'medicare_spend' => :'Float',
+        :'medicare_spend_year' => :'Integer',
+        :'disclosed_revenue_usd_millions' => :'Float',
+        :'disclosed_revenue_year' => :'Integer',
+        :'size_usd' => :'Float',
+        :'size_basis' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'drug_id',
+        :'drug_name',
+        :'pharm_class',
+        :'atc_class',
+        :'brand',
+        :'candidate_brands',
+        :'cliff_date',
+        :'cliff_year',
+        :'cliff_basis',
         :'cliff_source',
         :'cliff_confidence',
+        :'has_generic',
+        :'biosimilar_available',
+        :'applicant_name',
+        :'applicant_org_id',
+        :'applicant_company_id',
+        :'applicant_company_name',
+        :'applicant_group_id',
+        :'applicant_group_name',
+        :'applicant_match_scope',
         :'medicare_spend',
+        :'medicare_spend_year',
+        :'disclosed_revenue_usd_millions',
+        :'disclosed_revenue_year',
+        :'size_usd',
+        :'size_basis'
       ])
     end
 
@@ -90,197 +204,136 @@ 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::OrgsPatentCliff200ResponseRowsInner` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PharmaObservatory::DrugPatentCliffRow` 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::OrgsPatentCliff200ResponseRowsInner`. 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::DrugPatentCliffRow`. 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?(:'canonical_drug_id')
-        self.canonical_drug_id = attributes[:'canonical_drug_id']
-      else
-        self.canonical_drug_id = nil
+      if attributes.key?(:'drug_id')
+        self.drug_id = attributes[:'drug_id']
       end
 
       if attributes.key?(:'drug_name')
         self.drug_name = attributes[:'drug_name']
-      else
-        self.drug_name = nil
       end
 
-      if attributes.key?(:'cliff_year')
-        self.cliff_year = attributes[:'cliff_year']
-      else
-        self.cliff_year = nil
+      if attributes.key?(:'pharm_class')
+        self.pharm_class = attributes[:'pharm_class']
+      end
+
+      if attributes.key?(:'atc_class')
+        self.atc_class = attributes[:'atc_class']
+      end
+
+      if attributes.key?(:'brand')
+        self.brand = attributes[:'brand']
+      end
+
+      if attributes.key?(:'candidate_brands')
+        self.candidate_brands = attributes[:'candidate_brands']
       end
 
       if attributes.key?(:'cliff_date')
         self.cliff_date = attributes[:'cliff_date']
-      else
-        self.cliff_date = nil
+      end
+
+      if attributes.key?(:'cliff_year')
+        self.cliff_year = attributes[:'cliff_year']
       end
 
       if attributes.key?(:'cliff_basis')
         self.cliff_basis = attributes[:'cliff_basis']
-      else
-        self.cliff_basis = nil
       end
 
       if attributes.key?(:'cliff_source')
         self.cliff_source = attributes[:'cliff_source']
-      else
-        self.cliff_source = nil
       end
 
       if attributes.key?(:'cliff_confidence')
         self.cliff_confidence = attributes[:'cliff_confidence']
-      else
-        self.cliff_confidence = nil
-      end
-
-      if attributes.key?(:'medicare_spend')
-        self.medicare_spend = attributes[:'medicare_spend']
-      else
-        self.medicare_spend = nil
       end
 
       if attributes.key?(:'has_generic')
         self.has_generic = attributes[:'has_generic']
-      else
-        self.has_generic = nil
       end
 
       if attributes.key?(:'biosimilar_available')
         self.biosimilar_available = attributes[:'biosimilar_available']
-      else
-        self.biosimilar_available = nil
       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 @canonical_drug_id.nil?
-        invalid_properties.push('invalid value for "canonical_drug_id", canonical_drug_id cannot be nil.')
+      if attributes.key?(:'applicant_name')
+        self.applicant_name = attributes[:'applicant_name']
       end
 
-      if @drug_name.nil?
-        invalid_properties.push('invalid value for "drug_name", drug_name cannot be nil.')
+      if attributes.key?(:'applicant_org_id')
+        self.applicant_org_id = attributes[:'applicant_org_id']
       end
 
-      if @cliff_year.nil?
-        invalid_properties.push('invalid value for "cliff_year", cliff_year cannot be nil.')
+      if attributes.key?(:'applicant_company_id')
+        self.applicant_company_id = attributes[:'applicant_company_id']
       end
 
-      if @cliff_date.nil?
-        invalid_properties.push('invalid value for "cliff_date", cliff_date cannot be nil.')
+      if attributes.key?(:'applicant_company_name')
+        self.applicant_company_name = attributes[:'applicant_company_name']
       end
 
-      if @cliff_basis.nil?
-        invalid_properties.push('invalid value for "cliff_basis", cliff_basis cannot be nil.')
+      if attributes.key?(:'applicant_group_id')
+        self.applicant_group_id = attributes[:'applicant_group_id']
       end
 
-      if @has_generic.nil?
-        invalid_properties.push('invalid value for "has_generic", has_generic cannot be nil.')
+      if attributes.key?(:'applicant_group_name')
+        self.applicant_group_name = attributes[:'applicant_group_name']
       end
 
-      if @biosimilar_available.nil?
-        invalid_properties.push('invalid value for "biosimilar_available", biosimilar_available cannot be nil.')
+      if attributes.key?(:'applicant_match_scope')
+        self.applicant_match_scope = attributes[:'applicant_match_scope']
       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 @canonical_drug_id.nil?
-      return false if @drug_name.nil?
-      return false if @cliff_year.nil?
-      return false if @cliff_date.nil?
-      return false if @cliff_basis.nil?
-      return false if @has_generic.nil?
-      return false if @biosimilar_available.nil?
-      true
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] canonical_drug_id Value to be assigned
-    def canonical_drug_id=(canonical_drug_id)
-      if canonical_drug_id.nil?
-        fail ArgumentError, 'canonical_drug_id cannot be nil'
+      if attributes.key?(:'medicare_spend')
+        self.medicare_spend = attributes[:'medicare_spend']
       end
 
-      @canonical_drug_id = canonical_drug_id
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] drug_name Value to be assigned
-    def drug_name=(drug_name)
-      if drug_name.nil?
-        fail ArgumentError, 'drug_name cannot be nil'
+      if attributes.key?(:'medicare_spend_year')
+        self.medicare_spend_year = attributes[:'medicare_spend_year']
       end
 
-      @drug_name = drug_name
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] cliff_year Value to be assigned
-    def cliff_year=(cliff_year)
-      if cliff_year.nil?
-        fail ArgumentError, 'cliff_year cannot be nil'
+      if attributes.key?(:'disclosed_revenue_usd_millions')
+        self.disclosed_revenue_usd_millions = attributes[:'disclosed_revenue_usd_millions']
       end
 
-      @cliff_year = cliff_year
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] cliff_date Value to be assigned
-    def cliff_date=(cliff_date)
-      if cliff_date.nil?
-        fail ArgumentError, 'cliff_date cannot be nil'
+      if attributes.key?(:'disclosed_revenue_year')
+        self.disclosed_revenue_year = attributes[:'disclosed_revenue_year']
       end
 
-      @cliff_date = cliff_date
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] cliff_basis Value to be assigned
-    def cliff_basis=(cliff_basis)
-      if cliff_basis.nil?
-        fail ArgumentError, 'cliff_basis cannot be nil'
+      if attributes.key?(:'size_usd')
+        self.size_usd = attributes[:'size_usd']
       end
 
-      @cliff_basis = cliff_basis
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] has_generic Value to be assigned
-    def has_generic=(has_generic)
-      if has_generic.nil?
-        fail ArgumentError, 'has_generic cannot be nil'
+      if attributes.key?(:'size_basis')
+        self.size_basis = attributes[:'size_basis']
       end
-
-      @has_generic = has_generic
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] biosimilar_available Value to be assigned
-    def biosimilar_available=(biosimilar_available)
-      if biosimilar_available.nil?
-        fail ArgumentError, 'biosimilar_available cannot be nil'
-      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
 
-      @biosimilar_available = biosimilar_available
+    # 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'
+      true
     end
 
     # Checks equality by comparing each attribute.
@@ -288,16 +341,32 @@ module PharmaObservatory
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          canonical_drug_id == o.canonical_drug_id &&
+          drug_id == o.drug_id &&
           drug_name == o.drug_name &&
-          cliff_year == o.cliff_year &&
+          pharm_class == o.pharm_class &&
+          atc_class == o.atc_class &&
+          brand == o.brand &&
+          candidate_brands == o.candidate_brands &&
           cliff_date == o.cliff_date &&
+          cliff_year == o.cliff_year &&
           cliff_basis == o.cliff_basis &&
           cliff_source == o.cliff_source &&
           cliff_confidence == o.cliff_confidence &&
-          medicare_spend == o.medicare_spend &&
           has_generic == o.has_generic &&
-          biosimilar_available == o.biosimilar_available
+          biosimilar_available == o.biosimilar_available &&
+          applicant_name == o.applicant_name &&
+          applicant_org_id == o.applicant_org_id &&
+          applicant_company_id == o.applicant_company_id &&
+          applicant_company_name == o.applicant_company_name &&
+          applicant_group_id == o.applicant_group_id &&
+          applicant_group_name == o.applicant_group_name &&
+          applicant_match_scope == o.applicant_match_scope &&
+          medicare_spend == o.medicare_spend &&
+          medicare_spend_year == o.medicare_spend_year &&
+          disclosed_revenue_usd_millions == o.disclosed_revenue_usd_millions &&
+          disclosed_revenue_year == o.disclosed_revenue_year &&
+          size_usd == o.size_usd &&
+          size_basis == o.size_basis
     end
 
     # @see the `==` method
@@ -309,7 +378,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [canonical_drug_id, drug_name, cliff_year, cliff_date, cliff_basis, cliff_source, cliff_confidence, medicare_spend, has_generic, biosimilar_available].hash
+      [drug_id, drug_name, pharm_class, atc_class, brand, candidate_brands, cliff_date, cliff_year, cliff_basis, cliff_source, cliff_confidence, has_generic, biosimilar_available, applicant_name, applicant_org_id, applicant_company_id, applicant_company_name, applicant_group_id, applicant_group_name, applicant_match_scope, medicare_spend, medicare_spend_year, disclosed_revenue_usd_millions, disclosed_revenue_year, size_usd, size_basis].hash
     end
 
     # Builds the object from hash