pharmaobservatory 0.1.2 → 0.1.4

data/lib/pharmaobservatory/models/trials_row.rb

@@ -0,0 +1,784 @@
+=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
+  # One row of the trials dataset: one row per ClinicalTrials.gov trial. A grouped request returns the group columns and the measures instead, as additional properties.
+  class TrialsRow
+    # The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number).
+    attr_accessor :trial_id
+
+    # The trial's brief title.
+    attr_accessor :brief_title
+
+    # The trial's official title.
+    attr_accessor :official_title
+
+    # INTERVENTIONAL, OBSERVATIONAL or EXPANDED_ACCESS.
+    attr_accessor :study_type
+
+    # The registry's overall status code (RECRUITING, COMPLETED, TERMINATED and so on).
+    attr_accessor :overall_status
+
+    # A coarse status label derived from the overall status (Recruiting, Completed, Discontinued and so on).
+    attr_accessor :overall_status_summary
+
+    # The registry's phase code (PHASE1, PHASE2, PHASE2/PHASE3, NA).
+    attr_accessor :phase
+
+    # The trial phase as a label (Phase 2, Phase 3, Observational, Not applicable).
+    attr_accessor :phase_label
+
+    # The phase code and the status summary joined with a colon (PHASE2:Completed).
+    attr_accessor :phase_by_status
+
+    # Enrollment as registered: a planned target or an achieved count (see enrollment_type).
+    attr_accessor :enrollment
+
+    # ACTUAL (a count of enrolled participants) or ESTIMATED (a planned target).
+    attr_accessor :enrollment_type
+
+    # False when the registered enrollment is a placeholder value rather than a count.
+    attr_accessor :enrollment_is_plausible
+
+    # Why the registered enrollment was marked a placeholder (null when it was not).
+    attr_accessor :enrollment_flag_reason
+
+    # Trial start date.
+    attr_accessor :start_date
+
+    # Year of the trial start.
+    attr_accessor :start_year
+
+    # Primary completion date.
+    attr_accessor :primary_completion_date
+
+    # ACTUAL (a date that has occurred) or ESTIMATED (a planned date).
+    attr_accessor :primary_completion_date_type
+
+    # Completion date.
+    attr_accessor :completion_date
+
+    # ACTUAL (a date that has occurred) or ESTIMATED (a planned date).
+    attr_accessor :completion_date_type
+
+    # Date the study was first posted to the registry.
+    attr_accessor :study_first_posted_date
+
+    # Date the registry record was last updated.
+    attr_accessor :last_update_posted_date
+
+    # The sponsor's stated reason a trial was stopped early, as filed.
+    attr_accessor :why_stopped
+
+    # Number of study arms.
+    attr_accessor :number_of_arms
+
+    # Whether results are posted to the registry.
+    attr_accessor :were_results_reported
+
+    # Eligible sex: ALL, FEMALE or MALE.
+    attr_accessor :gender
+
+    # Minimum eligible age, as filed (for example 18 Years).
+    attr_accessor :minimum_age
+
+    # Maximum eligible age, as filed (for example 65 Years).
+    attr_accessor :maximum_age
+
+    # Whether healthy volunteers are accepted.
+    attr_accessor :healthy_volunteers
+
+    # The inclusion and exclusion criteria text, as filed.
+    attr_accessor :eligibility_criteria
+
+    # The lead sponsor name as filed.
+    attr_accessor :lead_sponsor_name
+
+    # Legal-entity level: the organization record the lead sponsor resolved to (null when unresolved).
+    attr_accessor :lead_sponsor_org_id
+
+    # Company level: the company the lead sponsor belongs to (null when unresolved).
+    attr_accessor :lead_sponsor_company_id
+
+    # Display name of the lead sponsor's company.
+    attr_accessor :lead_sponsor_company_name
+
+    # Group level: the lead sponsor's current ultimate parent company; a root company's group is itself.
+    attr_accessor :lead_sponsor_group_id
+
+    # Display name of the lead sponsor's group.
+    attr_accessor :lead_sponsor_group_name
+
+    # Collaborating sponsor names, as filed.
+    attr_accessor :collaborators
+
+    # Names of the lead sponsor and the collaborators, as filed.
+    attr_accessor :participating_sponsors
+
+    # Conditions studied, as registered.
+    attr_accessor :conditions
+
+    # Conditions studied, as Medical Subject Headings (MeSH) terms the registry assigns.
+    attr_accessor :condition_mesh
+
+    # Interventions, as registered.
+    attr_accessor :interventions
+
+    # Interventions as Medical Subject Headings (MeSH) terms the registry assigns.
+    attr_accessor :intervention_mesh
+
+    # Intervention types (DRUG, BIOLOGICAL, DEVICE and so on).
+    attr_accessor :intervention_types
+
+    # Number of study sites the registry record states.
+    attr_accessor :number_of_facilities
+
+    # Number of study sites listed on the record.
+    attr_accessor :facility_count
+
+    # Whether any listed site is in the United States.
+    attr_accessor :has_us_facility
+
+    # Number of countries with a listed site.
+    attr_accessor :facility_country_count
+
+    # Countries with a listed site.
+    attr_accessor :facility_countries
+
+    # MeSH condition ids the trial is linked to, direct and through the MeSH tree. Filter on one id to match the trials that carry it.
+    attr_accessor :condition_ids
+
+    # Drug ids the trial's interventions resolved to. Filter on one id to match the trials that carry it.
+    attr_accessor :drug_ids
+
+    # Organization record ids of the sponsors on the trial, lead and collaborator. Filter on one id to match the trials that carry it.
+    attr_accessor :sponsor_org_ids
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'trial_id' => :'trial_id',
+        :'brief_title' => :'brief_title',
+        :'official_title' => :'official_title',
+        :'study_type' => :'study_type',
+        :'overall_status' => :'overall_status',
+        :'overall_status_summary' => :'overall_status_summary',
+        :'phase' => :'phase',
+        :'phase_label' => :'phase_label',
+        :'phase_by_status' => :'phase_by_status',
+        :'enrollment' => :'enrollment',
+        :'enrollment_type' => :'enrollment_type',
+        :'enrollment_is_plausible' => :'enrollment_is_plausible',
+        :'enrollment_flag_reason' => :'enrollment_flag_reason',
+        :'start_date' => :'start_date',
+        :'start_year' => :'start_year',
+        :'primary_completion_date' => :'primary_completion_date',
+        :'primary_completion_date_type' => :'primary_completion_date_type',
+        :'completion_date' => :'completion_date',
+        :'completion_date_type' => :'completion_date_type',
+        :'study_first_posted_date' => :'study_first_posted_date',
+        :'last_update_posted_date' => :'last_update_posted_date',
+        :'why_stopped' => :'why_stopped',
+        :'number_of_arms' => :'number_of_arms',
+        :'were_results_reported' => :'were_results_reported',
+        :'gender' => :'gender',
+        :'minimum_age' => :'minimum_age',
+        :'maximum_age' => :'maximum_age',
+        :'healthy_volunteers' => :'healthy_volunteers',
+        :'eligibility_criteria' => :'eligibility_criteria',
+        :'lead_sponsor_name' => :'lead_sponsor_name',
+        :'lead_sponsor_org_id' => :'lead_sponsor_org_id',
+        :'lead_sponsor_company_id' => :'lead_sponsor_company_id',
+        :'lead_sponsor_company_name' => :'lead_sponsor_company_name',
+        :'lead_sponsor_group_id' => :'lead_sponsor_group_id',
+        :'lead_sponsor_group_name' => :'lead_sponsor_group_name',
+        :'collaborators' => :'collaborators',
+        :'participating_sponsors' => :'participating_sponsors',
+        :'conditions' => :'conditions',
+        :'condition_mesh' => :'condition_mesh',
+        :'interventions' => :'interventions',
+        :'intervention_mesh' => :'intervention_mesh',
+        :'intervention_types' => :'intervention_types',
+        :'number_of_facilities' => :'number_of_facilities',
+        :'facility_count' => :'facility_count',
+        :'has_us_facility' => :'has_us_facility',
+        :'facility_country_count' => :'facility_country_count',
+        :'facility_countries' => :'facility_countries',
+        :'condition_ids' => :'condition_ids',
+        :'drug_ids' => :'drug_ids',
+        :'sponsor_org_ids' => :'sponsor_org_ids'
+      }
+    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
+      {
+        :'trial_id' => :'String',
+        :'brief_title' => :'String',
+        :'official_title' => :'String',
+        :'study_type' => :'String',
+        :'overall_status' => :'String',
+        :'overall_status_summary' => :'String',
+        :'phase' => :'String',
+        :'phase_label' => :'String',
+        :'phase_by_status' => :'String',
+        :'enrollment' => :'Integer',
+        :'enrollment_type' => :'String',
+        :'enrollment_is_plausible' => :'Boolean',
+        :'enrollment_flag_reason' => :'String',
+        :'start_date' => :'Date',
+        :'start_year' => :'Integer',
+        :'primary_completion_date' => :'Date',
+        :'primary_completion_date_type' => :'String',
+        :'completion_date' => :'Date',
+        :'completion_date_type' => :'String',
+        :'study_first_posted_date' => :'Date',
+        :'last_update_posted_date' => :'Date',
+        :'why_stopped' => :'String',
+        :'number_of_arms' => :'Integer',
+        :'were_results_reported' => :'Boolean',
+        :'gender' => :'String',
+        :'minimum_age' => :'String',
+        :'maximum_age' => :'String',
+        :'healthy_volunteers' => :'Boolean',
+        :'eligibility_criteria' => :'String',
+        :'lead_sponsor_name' => :'String',
+        :'lead_sponsor_org_id' => :'String',
+        :'lead_sponsor_company_id' => :'String',
+        :'lead_sponsor_company_name' => :'String',
+        :'lead_sponsor_group_id' => :'String',
+        :'lead_sponsor_group_name' => :'String',
+        :'collaborators' => :'Array<String>',
+        :'participating_sponsors' => :'Array<String>',
+        :'conditions' => :'Array<String>',
+        :'condition_mesh' => :'Array<String>',
+        :'interventions' => :'Array<String>',
+        :'intervention_mesh' => :'Array<String>',
+        :'intervention_types' => :'Array<String>',
+        :'number_of_facilities' => :'Integer',
+        :'facility_count' => :'Integer',
+        :'has_us_facility' => :'Boolean',
+        :'facility_country_count' => :'Integer',
+        :'facility_countries' => :'Array<String>',
+        :'condition_ids' => :'Array<String>',
+        :'drug_ids' => :'Array<String>',
+        :'sponsor_org_ids' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'trial_id',
+        :'brief_title',
+        :'official_title',
+        :'study_type',
+        :'overall_status',
+        :'overall_status_summary',
+        :'phase',
+        :'phase_label',
+        :'phase_by_status',
+        :'enrollment',
+        :'enrollment_type',
+        :'enrollment_is_plausible',
+        :'enrollment_flag_reason',
+        :'start_date',
+        :'start_year',
+        :'primary_completion_date',
+        :'primary_completion_date_type',
+        :'completion_date',
+        :'completion_date_type',
+        :'study_first_posted_date',
+        :'last_update_posted_date',
+        :'why_stopped',
+        :'number_of_arms',
+        :'were_results_reported',
+        :'gender',
+        :'minimum_age',
+        :'maximum_age',
+        :'healthy_volunteers',
+        :'eligibility_criteria',
+        :'lead_sponsor_name',
+        :'lead_sponsor_org_id',
+        :'lead_sponsor_company_id',
+        :'lead_sponsor_company_name',
+        :'lead_sponsor_group_id',
+        :'lead_sponsor_group_name',
+        :'collaborators',
+        :'participating_sponsors',
+        :'conditions',
+        :'condition_mesh',
+        :'interventions',
+        :'intervention_mesh',
+        :'intervention_types',
+        :'number_of_facilities',
+        :'facility_count',
+        :'has_us_facility',
+        :'facility_country_count',
+        :'facility_countries',
+        :'condition_ids',
+        :'drug_ids',
+        :'sponsor_org_ids'
+      ])
+    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::TrialsRow` 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::TrialsRow`. 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?(:'trial_id')
+        self.trial_id = attributes[:'trial_id']
+      end
+
+      if attributes.key?(:'brief_title')
+        self.brief_title = attributes[:'brief_title']
+      end
+
+      if attributes.key?(:'official_title')
+        self.official_title = attributes[:'official_title']
+      end
+
+      if attributes.key?(:'study_type')
+        self.study_type = attributes[:'study_type']
+      end
+
+      if attributes.key?(:'overall_status')
+        self.overall_status = attributes[:'overall_status']
+      end
+
+      if attributes.key?(:'overall_status_summary')
+        self.overall_status_summary = attributes[:'overall_status_summary']
+      end
+
+      if attributes.key?(:'phase')
+        self.phase = attributes[:'phase']
+      end
+
+      if attributes.key?(:'phase_label')
+        self.phase_label = attributes[:'phase_label']
+      end
+
+      if attributes.key?(:'phase_by_status')
+        self.phase_by_status = attributes[:'phase_by_status']
+      end
+
+      if attributes.key?(:'enrollment')
+        self.enrollment = attributes[:'enrollment']
+      end
+
+      if attributes.key?(:'enrollment_type')
+        self.enrollment_type = attributes[:'enrollment_type']
+      end
+
+      if attributes.key?(:'enrollment_is_plausible')
+        self.enrollment_is_plausible = attributes[:'enrollment_is_plausible']
+      end
+
+      if attributes.key?(:'enrollment_flag_reason')
+        self.enrollment_flag_reason = attributes[:'enrollment_flag_reason']
+      end
+
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.key?(:'start_year')
+        self.start_year = attributes[:'start_year']
+      end
+
+      if attributes.key?(:'primary_completion_date')
+        self.primary_completion_date = attributes[:'primary_completion_date']
+      end
+
+      if attributes.key?(:'primary_completion_date_type')
+        self.primary_completion_date_type = attributes[:'primary_completion_date_type']
+      end
+
+      if attributes.key?(:'completion_date')
+        self.completion_date = attributes[:'completion_date']
+      end
+
+      if attributes.key?(:'completion_date_type')
+        self.completion_date_type = attributes[:'completion_date_type']
+      end
+
+      if attributes.key?(:'study_first_posted_date')
+        self.study_first_posted_date = attributes[:'study_first_posted_date']
+      end
+
+      if attributes.key?(:'last_update_posted_date')
+        self.last_update_posted_date = attributes[:'last_update_posted_date']
+      end
+
+      if attributes.key?(:'why_stopped')
+        self.why_stopped = attributes[:'why_stopped']
+      end
+
+      if attributes.key?(:'number_of_arms')
+        self.number_of_arms = attributes[:'number_of_arms']
+      end
+
+      if attributes.key?(:'were_results_reported')
+        self.were_results_reported = attributes[:'were_results_reported']
+      end
+
+      if attributes.key?(:'gender')
+        self.gender = attributes[:'gender']
+      end
+
+      if attributes.key?(:'minimum_age')
+        self.minimum_age = attributes[:'minimum_age']
+      end
+
+      if attributes.key?(:'maximum_age')
+        self.maximum_age = attributes[:'maximum_age']
+      end
+
+      if attributes.key?(:'healthy_volunteers')
+        self.healthy_volunteers = attributes[:'healthy_volunteers']
+      end
+
+      if attributes.key?(:'eligibility_criteria')
+        self.eligibility_criteria = attributes[:'eligibility_criteria']
+      end
+
+      if attributes.key?(:'lead_sponsor_name')
+        self.lead_sponsor_name = attributes[:'lead_sponsor_name']
+      end
+
+      if attributes.key?(:'lead_sponsor_org_id')
+        self.lead_sponsor_org_id = attributes[:'lead_sponsor_org_id']
+      end
+
+      if attributes.key?(:'lead_sponsor_company_id')
+        self.lead_sponsor_company_id = attributes[:'lead_sponsor_company_id']
+      end
+
+      if attributes.key?(:'lead_sponsor_company_name')
+        self.lead_sponsor_company_name = attributes[:'lead_sponsor_company_name']
+      end
+
+      if attributes.key?(:'lead_sponsor_group_id')
+        self.lead_sponsor_group_id = attributes[:'lead_sponsor_group_id']
+      end
+
+      if attributes.key?(:'lead_sponsor_group_name')
+        self.lead_sponsor_group_name = attributes[:'lead_sponsor_group_name']
+      end
+
+      if attributes.key?(:'collaborators')
+        if (value = attributes[:'collaborators']).is_a?(Array)
+          self.collaborators = value
+        end
+      end
+
+      if attributes.key?(:'participating_sponsors')
+        if (value = attributes[:'participating_sponsors']).is_a?(Array)
+          self.participating_sponsors = value
+        end
+      end
+
+      if attributes.key?(:'conditions')
+        if (value = attributes[:'conditions']).is_a?(Array)
+          self.conditions = value
+        end
+      end
+
+      if attributes.key?(:'condition_mesh')
+        if (value = attributes[:'condition_mesh']).is_a?(Array)
+          self.condition_mesh = value
+        end
+      end
+
+      if attributes.key?(:'interventions')
+        if (value = attributes[:'interventions']).is_a?(Array)
+          self.interventions = value
+        end
+      end
+
+      if attributes.key?(:'intervention_mesh')
+        if (value = attributes[:'intervention_mesh']).is_a?(Array)
+          self.intervention_mesh = value
+        end
+      end
+
+      if attributes.key?(:'intervention_types')
+        if (value = attributes[:'intervention_types']).is_a?(Array)
+          self.intervention_types = value
+        end
+      end
+
+      if attributes.key?(:'number_of_facilities')
+        self.number_of_facilities = attributes[:'number_of_facilities']
+      end
+
+      if attributes.key?(:'facility_count')
+        self.facility_count = attributes[:'facility_count']
+      end
+
+      if attributes.key?(:'has_us_facility')
+        self.has_us_facility = attributes[:'has_us_facility']
+      end
+
+      if attributes.key?(:'facility_country_count')
+        self.facility_country_count = attributes[:'facility_country_count']
+      end
+
+      if attributes.key?(:'facility_countries')
+        if (value = attributes[:'facility_countries']).is_a?(Array)
+          self.facility_countries = value
+        end
+      end
+
+      if attributes.key?(:'condition_ids')
+        if (value = attributes[:'condition_ids']).is_a?(Array)
+          self.condition_ids = value
+        end
+      end
+
+      if attributes.key?(:'drug_ids')
+        if (value = attributes[:'drug_ids']).is_a?(Array)
+          self.drug_ids = value
+        end
+      end
+
+      if attributes.key?(:'sponsor_org_ids')
+        if (value = attributes[:'sponsor_org_ids']).is_a?(Array)
+          self.sponsor_org_ids = 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
+      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'
+      true
+    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 &&
+          trial_id == o.trial_id &&
+          brief_title == o.brief_title &&
+          official_title == o.official_title &&
+          study_type == o.study_type &&
+          overall_status == o.overall_status &&
+          overall_status_summary == o.overall_status_summary &&
+          phase == o.phase &&
+          phase_label == o.phase_label &&
+          phase_by_status == o.phase_by_status &&
+          enrollment == o.enrollment &&
+          enrollment_type == o.enrollment_type &&
+          enrollment_is_plausible == o.enrollment_is_plausible &&
+          enrollment_flag_reason == o.enrollment_flag_reason &&
+          start_date == o.start_date &&
+          start_year == o.start_year &&
+          primary_completion_date == o.primary_completion_date &&
+          primary_completion_date_type == o.primary_completion_date_type &&
+          completion_date == o.completion_date &&
+          completion_date_type == o.completion_date_type &&
+          study_first_posted_date == o.study_first_posted_date &&
+          last_update_posted_date == o.last_update_posted_date &&
+          why_stopped == o.why_stopped &&
+          number_of_arms == o.number_of_arms &&
+          were_results_reported == o.were_results_reported &&
+          gender == o.gender &&
+          minimum_age == o.minimum_age &&
+          maximum_age == o.maximum_age &&
+          healthy_volunteers == o.healthy_volunteers &&
+          eligibility_criteria == o.eligibility_criteria &&
+          lead_sponsor_name == o.lead_sponsor_name &&
+          lead_sponsor_org_id == o.lead_sponsor_org_id &&
+          lead_sponsor_company_id == o.lead_sponsor_company_id &&
+          lead_sponsor_company_name == o.lead_sponsor_company_name &&
+          lead_sponsor_group_id == o.lead_sponsor_group_id &&
+          lead_sponsor_group_name == o.lead_sponsor_group_name &&
+          collaborators == o.collaborators &&
+          participating_sponsors == o.participating_sponsors &&
+          conditions == o.conditions &&
+          condition_mesh == o.condition_mesh &&
+          interventions == o.interventions &&
+          intervention_mesh == o.intervention_mesh &&
+          intervention_types == o.intervention_types &&
+          number_of_facilities == o.number_of_facilities &&
+          facility_count == o.facility_count &&
+          has_us_facility == o.has_us_facility &&
+          facility_country_count == o.facility_country_count &&
+          facility_countries == o.facility_countries &&
+          condition_ids == o.condition_ids &&
+          drug_ids == o.drug_ids &&
+          sponsor_org_ids == o.sponsor_org_ids
+    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
+      [trial_id, brief_title, official_title, study_type, overall_status, overall_status_summary, phase, phase_label, phase_by_status, enrollment, enrollment_type, enrollment_is_plausible, enrollment_flag_reason, start_date, start_year, primary_completion_date, primary_completion_date_type, completion_date, completion_date_type, study_first_posted_date, last_update_posted_date, why_stopped, number_of_arms, were_results_reported, gender, minimum_age, maximum_age, healthy_volunteers, eligibility_criteria, lead_sponsor_name, lead_sponsor_org_id, lead_sponsor_company_id, lead_sponsor_company_name, lead_sponsor_group_id, lead_sponsor_group_name, collaborators, participating_sponsors, conditions, condition_mesh, interventions, intervention_mesh, intervention_types, number_of_facilities, facility_count, has_us_facility, facility_country_count, facility_countries, condition_ids, drug_ids, sponsor_org_ids].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