pharmaobservatory 0.1.7 → 0.1.9

data/lib/pharmaobservatory/models/ownership_observations_row.rb

@@ -0,0 +1,1048 @@
+=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 ownership_observations dataset: one row per ownership assertion (a filing's statement), including superseded ones. A grouped request returns the group columns and the measures instead, as additional properties.
+  class OwnershipObservationsRow
+    # The observation id.
+    attr_accessor :ownership_observation_id
+
+    # The id the source gave the assertion.
+    attr_accessor :source_observation_id
+
+    # The earlier observation this one amends or replaces.
+    attr_accessor :supersedes_observation_id
+
+    # The later observation that supersedes this one (the lowest when more than one claims it).
+    attr_accessor :superseded_by_observation_id
+
+    # How many later observations claim to supersede this one; above 1 is a lineage conflict kept as filed.
+    attr_accessor :superseded_by_count
+
+    # The id of the amendment thread this observation belongs to.
+    attr_accessor :supersession_chain_id
+
+    # Position in the amendment thread; 0 is the first filing.
+    attr_accessor :supersession_depth
+
+    # True when nothing supersedes this observation.
+    attr_accessor :is_chain_terminal
+
+    # True when the amendment thread was cut at 25 steps.
+    attr_accessor :chain_truncated
+
+    # The source system that made the assertion.
+    attr_accessor :source_system
+
+    # The filing family: sec_forms_3_4_5, sec_schedules_13d_g, sec_form_adv, sec_def_14a or wikidata.
+    attr_accessor :source_class
+
+    # The ownership semantic the assertion carries, from the project's controlled taxonomy.
+    attr_accessor :semantic_key
+
+    # The owner's relationship to the company as the filing family states it.
+    attr_accessor :relationship_type
+
+    # What the observation measures: economic_interest, voting_power, beneficial_ownership, investment_discretion, insider_reporting, consolidation, control or unspecified. Different dimensions are different measurements.
+    attr_accessor :ownership_dimension
+
+    # direct, indirect, mixed or unspecified.
+    attr_accessor :directness
+
+    # What the owner is: organization, natural_person, reporting_group, government or unknown.
+    attr_accessor :owner_kind
+
+    # The owned party as the source identifies it.
+    attr_accessor :subject_source_ref
+
+    # The owned company as filed.
+    attr_accessor :subject_name
+
+    # The legal entity the source resolved the owned party to, when it did.
+    attr_accessor :subject_legal_entity_id
+
+    # Company level: the subject company (null when unresolved).
+    attr_accessor :subject_company_id
+
+    # Display name of the subject company.
+    attr_accessor :subject_company_name
+
+    # Group level: the subject company's current ultimate parent; a root's group is itself.
+    attr_accessor :subject_group_id
+
+    # Display name of the subject company's group.
+    attr_accessor :subject_group_name
+
+    # Legal-entity level: the owned company's organization record.
+    attr_accessor :subject_org_id
+
+    # The investor directory key of the owned party when it is an investor.
+    attr_accessor :subject_investor_id
+
+    # How the owned party was resolved.
+    attr_accessor :subject_resolution_method
+
+    # Confidence of that resolution, 0 to 1.
+    attr_accessor :subject_resolution_confidence
+
+    # The owner as the source identifies it.
+    attr_accessor :owner_source_ref
+
+    # The owner's name as filed.
+    attr_accessor :owner_name
+
+    # The legal entity the source resolved the owner to, when it did.
+    attr_accessor :owner_legal_entity_id
+
+    # Company level: the owner company (null when unresolved).
+    attr_accessor :owner_company_id
+
+    # Display name of the owner company.
+    attr_accessor :owner_company_name
+
+    # Group level: the owner company's current ultimate parent; a root's group is itself.
+    attr_accessor :owner_group_id
+
+    # Display name of the owner company's group.
+    attr_accessor :owner_group_name
+
+    # Legal-entity level: the owner's organization record.
+    attr_accessor :owner_org_id
+
+    # The investor directory key of the owner when it is one.
+    attr_accessor :owner_investor_id
+
+    # The key of an owner who is a natural person; null for other owners.
+    attr_accessor :owner_person_id
+
+    # How the person key was linked: edgar_cik, adviser_crd, unresolved_person or not_person.
+    attr_accessor :person_link_method
+
+    # True when the owner links to more than one person key.
+    attr_accessor :person_link_conflict
+
+    # How the owner was resolved.
+    attr_accessor :owner_resolution_method
+
+    # Confidence of that resolution, 0 to 1.
+    attr_accessor :owner_resolution_confidence
+
+    # The review state of the resolution.
+    attr_accessor :review_state
+
+    # How the stake is stated: exact, range, band, explicitly_unknown, not_reported or not_applicable. No midpoint, zero or numeral is invented for a non-numeric state.
+    attr_accessor :stake_value_type
+
+    # What the percentage is a share of: economic_interest, voting_power, beneficial_ownership, control or ownership_unspecified.
+    attr_accessor :percentage_basis
+
+    # The stake as an exact percentage, 0 to 100.
+    attr_accessor :stake_percent
+
+    # The lower bound of a range or band stake, 0 to 100.
+    attr_accessor :stake_lower_percent
+
+    # The upper bound of a range or band stake, 0 to 100.
+    attr_accessor :stake_upper_percent
+
+    # Whether the lower bound is included.
+    attr_accessor :stake_lower_inclusive
+
+    # Whether the upper bound is included.
+    attr_accessor :stake_upper_inclusive
+
+    # The source's band code, when the stake is a band.
+    attr_accessor :stake_band_code
+
+    # A label for the stake that never invents a number, such as 5.5%, 5% to 10% or Not reported.
+    attr_accessor :stake_display
+
+    # The security the stake is in, as filed.
+    attr_accessor :security_title
+
+    # The number of shares, when the source states one.
+    attr_accessor :shares_amount
+
+    # The reported value, in reported_value_currency at reported_value_scale.
+    attr_accessor :reported_value_amount
+
+    # The currency of the reported value.
+    attr_accessor :reported_value_currency
+
+    # The scale of the reported value as filed.
+    attr_accessor :reported_value_scale
+
+    # The date announced.
+    attr_accessor :announced_date
+
+    # The effective date.
+    attr_accessor :effective_date
+
+    # The filing date.
+    attr_accessor :filing_date
+
+    # The as-of date of the figure.
+    attr_accessor :as_of_date
+
+    # The date the position ceased.
+    attr_accessor :ceased_date
+
+    # The sort date: the first of as_of_date, effective_date, filing_date and announced_date that is present.
+    attr_accessor :observation_date
+
+    # Which of those dates observation_date took, or unavailable.
+    attr_accessor :observation_date_basis
+
+    # The lifecycle status the source states.
+    attr_accessor :lifecycle_status
+
+    # The id of the source document.
+    attr_accessor :source_document_id
+
+    # The link to the filing.
+    attr_accessor :source_url
+
+    # A hash of the source content, for change detection.
+    attr_accessor :source_content_hash
+
+    # The quoted evidence from the source.
+    attr_accessor :evidence_quote
+
+    # The tier vocabulary is none or licensable. Every row here is none: every source behind the ledger is open, and a data test reports any other tier.
+    attr_accessor :restriction_tier
+
+    # The licence of the source.
+    attr_accessor :source_license
+
+    # Whether the source licence allows commercial use.
+    attr_accessor :commercial_use_allowed
+
+    # The source credit text for the row.
+    attr_accessor :attribution
+
+    # A tag, never a gate: true when the source row carries a natural person's data.
+    attr_accessor :contains_personal_data
+
+    # The source's own privacy classification of the row.
+    attr_accessor :privacy_status
+
+    # True when this observation is the one the current ownership edge selected.
+    attr_accessor :is_current_edge
+
+    # The state of the current edge when is_current_edge.
+    attr_accessor :current_edge_state
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ownership_observation_id' => :'ownership_observation_id',
+        :'source_observation_id' => :'source_observation_id',
+        :'supersedes_observation_id' => :'supersedes_observation_id',
+        :'superseded_by_observation_id' => :'superseded_by_observation_id',
+        :'superseded_by_count' => :'superseded_by_count',
+        :'supersession_chain_id' => :'supersession_chain_id',
+        :'supersession_depth' => :'supersession_depth',
+        :'is_chain_terminal' => :'is_chain_terminal',
+        :'chain_truncated' => :'chain_truncated',
+        :'source_system' => :'source_system',
+        :'source_class' => :'source_class',
+        :'semantic_key' => :'semantic_key',
+        :'relationship_type' => :'relationship_type',
+        :'ownership_dimension' => :'ownership_dimension',
+        :'directness' => :'directness',
+        :'owner_kind' => :'owner_kind',
+        :'subject_source_ref' => :'subject_source_ref',
+        :'subject_name' => :'subject_name',
+        :'subject_legal_entity_id' => :'subject_legal_entity_id',
+        :'subject_company_id' => :'subject_company_id',
+        :'subject_company_name' => :'subject_company_name',
+        :'subject_group_id' => :'subject_group_id',
+        :'subject_group_name' => :'subject_group_name',
+        :'subject_org_id' => :'subject_org_id',
+        :'subject_investor_id' => :'subject_investor_id',
+        :'subject_resolution_method' => :'subject_resolution_method',
+        :'subject_resolution_confidence' => :'subject_resolution_confidence',
+        :'owner_source_ref' => :'owner_source_ref',
+        :'owner_name' => :'owner_name',
+        :'owner_legal_entity_id' => :'owner_legal_entity_id',
+        :'owner_company_id' => :'owner_company_id',
+        :'owner_company_name' => :'owner_company_name',
+        :'owner_group_id' => :'owner_group_id',
+        :'owner_group_name' => :'owner_group_name',
+        :'owner_org_id' => :'owner_org_id',
+        :'owner_investor_id' => :'owner_investor_id',
+        :'owner_person_id' => :'owner_person_id',
+        :'person_link_method' => :'person_link_method',
+        :'person_link_conflict' => :'person_link_conflict',
+        :'owner_resolution_method' => :'owner_resolution_method',
+        :'owner_resolution_confidence' => :'owner_resolution_confidence',
+        :'review_state' => :'review_state',
+        :'stake_value_type' => :'stake_value_type',
+        :'percentage_basis' => :'percentage_basis',
+        :'stake_percent' => :'stake_percent',
+        :'stake_lower_percent' => :'stake_lower_percent',
+        :'stake_upper_percent' => :'stake_upper_percent',
+        :'stake_lower_inclusive' => :'stake_lower_inclusive',
+        :'stake_upper_inclusive' => :'stake_upper_inclusive',
+        :'stake_band_code' => :'stake_band_code',
+        :'stake_display' => :'stake_display',
+        :'security_title' => :'security_title',
+        :'shares_amount' => :'shares_amount',
+        :'reported_value_amount' => :'reported_value_amount',
+        :'reported_value_currency' => :'reported_value_currency',
+        :'reported_value_scale' => :'reported_value_scale',
+        :'announced_date' => :'announced_date',
+        :'effective_date' => :'effective_date',
+        :'filing_date' => :'filing_date',
+        :'as_of_date' => :'as_of_date',
+        :'ceased_date' => :'ceased_date',
+        :'observation_date' => :'observation_date',
+        :'observation_date_basis' => :'observation_date_basis',
+        :'lifecycle_status' => :'lifecycle_status',
+        :'source_document_id' => :'source_document_id',
+        :'source_url' => :'source_url',
+        :'source_content_hash' => :'source_content_hash',
+        :'evidence_quote' => :'evidence_quote',
+        :'restriction_tier' => :'restriction_tier',
+        :'source_license' => :'source_license',
+        :'commercial_use_allowed' => :'commercial_use_allowed',
+        :'attribution' => :'attribution',
+        :'contains_personal_data' => :'contains_personal_data',
+        :'privacy_status' => :'privacy_status',
+        :'is_current_edge' => :'is_current_edge',
+        :'current_edge_state' => :'current_edge_state'
+      }
+    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
+      {
+        :'ownership_observation_id' => :'String',
+        :'source_observation_id' => :'String',
+        :'supersedes_observation_id' => :'String',
+        :'superseded_by_observation_id' => :'String',
+        :'superseded_by_count' => :'Integer',
+        :'supersession_chain_id' => :'String',
+        :'supersession_depth' => :'Integer',
+        :'is_chain_terminal' => :'Boolean',
+        :'chain_truncated' => :'Boolean',
+        :'source_system' => :'String',
+        :'source_class' => :'String',
+        :'semantic_key' => :'String',
+        :'relationship_type' => :'String',
+        :'ownership_dimension' => :'String',
+        :'directness' => :'String',
+        :'owner_kind' => :'String',
+        :'subject_source_ref' => :'String',
+        :'subject_name' => :'String',
+        :'subject_legal_entity_id' => :'String',
+        :'subject_company_id' => :'String',
+        :'subject_company_name' => :'String',
+        :'subject_group_id' => :'String',
+        :'subject_group_name' => :'String',
+        :'subject_org_id' => :'String',
+        :'subject_investor_id' => :'String',
+        :'subject_resolution_method' => :'String',
+        :'subject_resolution_confidence' => :'Float',
+        :'owner_source_ref' => :'String',
+        :'owner_name' => :'String',
+        :'owner_legal_entity_id' => :'String',
+        :'owner_company_id' => :'String',
+        :'owner_company_name' => :'String',
+        :'owner_group_id' => :'String',
+        :'owner_group_name' => :'String',
+        :'owner_org_id' => :'String',
+        :'owner_investor_id' => :'String',
+        :'owner_person_id' => :'String',
+        :'person_link_method' => :'String',
+        :'person_link_conflict' => :'Boolean',
+        :'owner_resolution_method' => :'String',
+        :'owner_resolution_confidence' => :'Float',
+        :'review_state' => :'String',
+        :'stake_value_type' => :'String',
+        :'percentage_basis' => :'String',
+        :'stake_percent' => :'Float',
+        :'stake_lower_percent' => :'Float',
+        :'stake_upper_percent' => :'Float',
+        :'stake_lower_inclusive' => :'Boolean',
+        :'stake_upper_inclusive' => :'Boolean',
+        :'stake_band_code' => :'String',
+        :'stake_display' => :'String',
+        :'security_title' => :'String',
+        :'shares_amount' => :'Float',
+        :'reported_value_amount' => :'Float',
+        :'reported_value_currency' => :'String',
+        :'reported_value_scale' => :'String',
+        :'announced_date' => :'Date',
+        :'effective_date' => :'Date',
+        :'filing_date' => :'Date',
+        :'as_of_date' => :'Date',
+        :'ceased_date' => :'Date',
+        :'observation_date' => :'Date',
+        :'observation_date_basis' => :'String',
+        :'lifecycle_status' => :'String',
+        :'source_document_id' => :'String',
+        :'source_url' => :'String',
+        :'source_content_hash' => :'String',
+        :'evidence_quote' => :'String',
+        :'restriction_tier' => :'String',
+        :'source_license' => :'String',
+        :'commercial_use_allowed' => :'Boolean',
+        :'attribution' => :'String',
+        :'contains_personal_data' => :'Boolean',
+        :'privacy_status' => :'String',
+        :'is_current_edge' => :'Boolean',
+        :'current_edge_state' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'ownership_observation_id',
+        :'source_observation_id',
+        :'supersedes_observation_id',
+        :'superseded_by_observation_id',
+        :'superseded_by_count',
+        :'supersession_chain_id',
+        :'supersession_depth',
+        :'is_chain_terminal',
+        :'chain_truncated',
+        :'source_system',
+        :'source_class',
+        :'semantic_key',
+        :'relationship_type',
+        :'ownership_dimension',
+        :'directness',
+        :'owner_kind',
+        :'subject_source_ref',
+        :'subject_name',
+        :'subject_legal_entity_id',
+        :'subject_company_id',
+        :'subject_company_name',
+        :'subject_group_id',
+        :'subject_group_name',
+        :'subject_org_id',
+        :'subject_investor_id',
+        :'subject_resolution_method',
+        :'subject_resolution_confidence',
+        :'owner_source_ref',
+        :'owner_name',
+        :'owner_legal_entity_id',
+        :'owner_company_id',
+        :'owner_company_name',
+        :'owner_group_id',
+        :'owner_group_name',
+        :'owner_org_id',
+        :'owner_investor_id',
+        :'owner_person_id',
+        :'person_link_method',
+        :'person_link_conflict',
+        :'owner_resolution_method',
+        :'owner_resolution_confidence',
+        :'review_state',
+        :'stake_value_type',
+        :'percentage_basis',
+        :'stake_percent',
+        :'stake_lower_percent',
+        :'stake_upper_percent',
+        :'stake_lower_inclusive',
+        :'stake_upper_inclusive',
+        :'stake_band_code',
+        :'stake_display',
+        :'security_title',
+        :'shares_amount',
+        :'reported_value_amount',
+        :'reported_value_currency',
+        :'reported_value_scale',
+        :'announced_date',
+        :'effective_date',
+        :'filing_date',
+        :'as_of_date',
+        :'ceased_date',
+        :'observation_date',
+        :'observation_date_basis',
+        :'lifecycle_status',
+        :'source_document_id',
+        :'source_url',
+        :'source_content_hash',
+        :'evidence_quote',
+        :'restriction_tier',
+        :'source_license',
+        :'commercial_use_allowed',
+        :'attribution',
+        :'contains_personal_data',
+        :'privacy_status',
+        :'is_current_edge',
+        :'current_edge_state'
+      ])
+    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::OwnershipObservationsRow` 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::OwnershipObservationsRow`. 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?(:'ownership_observation_id')
+        self.ownership_observation_id = attributes[:'ownership_observation_id']
+      end
+
+      if attributes.key?(:'source_observation_id')
+        self.source_observation_id = attributes[:'source_observation_id']
+      end
+
+      if attributes.key?(:'supersedes_observation_id')
+        self.supersedes_observation_id = attributes[:'supersedes_observation_id']
+      end
+
+      if attributes.key?(:'superseded_by_observation_id')
+        self.superseded_by_observation_id = attributes[:'superseded_by_observation_id']
+      end
+
+      if attributes.key?(:'superseded_by_count')
+        self.superseded_by_count = attributes[:'superseded_by_count']
+      end
+
+      if attributes.key?(:'supersession_chain_id')
+        self.supersession_chain_id = attributes[:'supersession_chain_id']
+      end
+
+      if attributes.key?(:'supersession_depth')
+        self.supersession_depth = attributes[:'supersession_depth']
+      end
+
+      if attributes.key?(:'is_chain_terminal')
+        self.is_chain_terminal = attributes[:'is_chain_terminal']
+      end
+
+      if attributes.key?(:'chain_truncated')
+        self.chain_truncated = attributes[:'chain_truncated']
+      end
+
+      if attributes.key?(:'source_system')
+        self.source_system = attributes[:'source_system']
+      end
+
+      if attributes.key?(:'source_class')
+        self.source_class = attributes[:'source_class']
+      end
+
+      if attributes.key?(:'semantic_key')
+        self.semantic_key = attributes[:'semantic_key']
+      end
+
+      if attributes.key?(:'relationship_type')
+        self.relationship_type = attributes[:'relationship_type']
+      end
+
+      if attributes.key?(:'ownership_dimension')
+        self.ownership_dimension = attributes[:'ownership_dimension']
+      end
+
+      if attributes.key?(:'directness')
+        self.directness = attributes[:'directness']
+      end
+
+      if attributes.key?(:'owner_kind')
+        self.owner_kind = attributes[:'owner_kind']
+      end
+
+      if attributes.key?(:'subject_source_ref')
+        self.subject_source_ref = attributes[:'subject_source_ref']
+      end
+
+      if attributes.key?(:'subject_name')
+        self.subject_name = attributes[:'subject_name']
+      end
+
+      if attributes.key?(:'subject_legal_entity_id')
+        self.subject_legal_entity_id = attributes[:'subject_legal_entity_id']
+      end
+
+      if attributes.key?(:'subject_company_id')
+        self.subject_company_id = attributes[:'subject_company_id']
+      end
+
+      if attributes.key?(:'subject_company_name')
+        self.subject_company_name = attributes[:'subject_company_name']
+      end
+
+      if attributes.key?(:'subject_group_id')
+        self.subject_group_id = attributes[:'subject_group_id']
+      end
+
+      if attributes.key?(:'subject_group_name')
+        self.subject_group_name = attributes[:'subject_group_name']
+      end
+
+      if attributes.key?(:'subject_org_id')
+        self.subject_org_id = attributes[:'subject_org_id']
+      end
+
+      if attributes.key?(:'subject_investor_id')
+        self.subject_investor_id = attributes[:'subject_investor_id']
+      end
+
+      if attributes.key?(:'subject_resolution_method')
+        self.subject_resolution_method = attributes[:'subject_resolution_method']
+      end
+
+      if attributes.key?(:'subject_resolution_confidence')
+        self.subject_resolution_confidence = attributes[:'subject_resolution_confidence']
+      end
+
+      if attributes.key?(:'owner_source_ref')
+        self.owner_source_ref = attributes[:'owner_source_ref']
+      end
+
+      if attributes.key?(:'owner_name')
+        self.owner_name = attributes[:'owner_name']
+      end
+
+      if attributes.key?(:'owner_legal_entity_id')
+        self.owner_legal_entity_id = attributes[:'owner_legal_entity_id']
+      end
+
+      if attributes.key?(:'owner_company_id')
+        self.owner_company_id = attributes[:'owner_company_id']
+      end
+
+      if attributes.key?(:'owner_company_name')
+        self.owner_company_name = attributes[:'owner_company_name']
+      end
+
+      if attributes.key?(:'owner_group_id')
+        self.owner_group_id = attributes[:'owner_group_id']
+      end
+
+      if attributes.key?(:'owner_group_name')
+        self.owner_group_name = attributes[:'owner_group_name']
+      end
+
+      if attributes.key?(:'owner_org_id')
+        self.owner_org_id = attributes[:'owner_org_id']
+      end
+
+      if attributes.key?(:'owner_investor_id')
+        self.owner_investor_id = attributes[:'owner_investor_id']
+      end
+
+      if attributes.key?(:'owner_person_id')
+        self.owner_person_id = attributes[:'owner_person_id']
+      end
+
+      if attributes.key?(:'person_link_method')
+        self.person_link_method = attributes[:'person_link_method']
+      end
+
+      if attributes.key?(:'person_link_conflict')
+        self.person_link_conflict = attributes[:'person_link_conflict']
+      end
+
+      if attributes.key?(:'owner_resolution_method')
+        self.owner_resolution_method = attributes[:'owner_resolution_method']
+      end
+
+      if attributes.key?(:'owner_resolution_confidence')
+        self.owner_resolution_confidence = attributes[:'owner_resolution_confidence']
+      end
+
+      if attributes.key?(:'review_state')
+        self.review_state = attributes[:'review_state']
+      end
+
+      if attributes.key?(:'stake_value_type')
+        self.stake_value_type = attributes[:'stake_value_type']
+      end
+
+      if attributes.key?(:'percentage_basis')
+        self.percentage_basis = attributes[:'percentage_basis']
+      end
+
+      if attributes.key?(:'stake_percent')
+        self.stake_percent = attributes[:'stake_percent']
+      end
+
+      if attributes.key?(:'stake_lower_percent')
+        self.stake_lower_percent = attributes[:'stake_lower_percent']
+      end
+
+      if attributes.key?(:'stake_upper_percent')
+        self.stake_upper_percent = attributes[:'stake_upper_percent']
+      end
+
+      if attributes.key?(:'stake_lower_inclusive')
+        self.stake_lower_inclusive = attributes[:'stake_lower_inclusive']
+      end
+
+      if attributes.key?(:'stake_upper_inclusive')
+        self.stake_upper_inclusive = attributes[:'stake_upper_inclusive']
+      end
+
+      if attributes.key?(:'stake_band_code')
+        self.stake_band_code = attributes[:'stake_band_code']
+      end
+
+      if attributes.key?(:'stake_display')
+        self.stake_display = attributes[:'stake_display']
+      end
+
+      if attributes.key?(:'security_title')
+        self.security_title = attributes[:'security_title']
+      end
+
+      if attributes.key?(:'shares_amount')
+        self.shares_amount = attributes[:'shares_amount']
+      end
+
+      if attributes.key?(:'reported_value_amount')
+        self.reported_value_amount = attributes[:'reported_value_amount']
+      end
+
+      if attributes.key?(:'reported_value_currency')
+        self.reported_value_currency = attributes[:'reported_value_currency']
+      end
+
+      if attributes.key?(:'reported_value_scale')
+        self.reported_value_scale = attributes[:'reported_value_scale']
+      end
+
+      if attributes.key?(:'announced_date')
+        self.announced_date = attributes[:'announced_date']
+      end
+
+      if attributes.key?(:'effective_date')
+        self.effective_date = attributes[:'effective_date']
+      end
+
+      if attributes.key?(:'filing_date')
+        self.filing_date = attributes[:'filing_date']
+      end
+
+      if attributes.key?(:'as_of_date')
+        self.as_of_date = attributes[:'as_of_date']
+      end
+
+      if attributes.key?(:'ceased_date')
+        self.ceased_date = attributes[:'ceased_date']
+      end
+
+      if attributes.key?(:'observation_date')
+        self.observation_date = attributes[:'observation_date']
+      end
+
+      if attributes.key?(:'observation_date_basis')
+        self.observation_date_basis = attributes[:'observation_date_basis']
+      end
+
+      if attributes.key?(:'lifecycle_status')
+        self.lifecycle_status = attributes[:'lifecycle_status']
+      end
+
+      if attributes.key?(:'source_document_id')
+        self.source_document_id = attributes[:'source_document_id']
+      end
+
+      if attributes.key?(:'source_url')
+        self.source_url = attributes[:'source_url']
+      end
+
+      if attributes.key?(:'source_content_hash')
+        self.source_content_hash = attributes[:'source_content_hash']
+      end
+
+      if attributes.key?(:'evidence_quote')
+        self.evidence_quote = attributes[:'evidence_quote']
+      end
+
+      if attributes.key?(:'restriction_tier')
+        self.restriction_tier = attributes[:'restriction_tier']
+      end
+
+      if attributes.key?(:'source_license')
+        self.source_license = attributes[:'source_license']
+      end
+
+      if attributes.key?(:'commercial_use_allowed')
+        self.commercial_use_allowed = attributes[:'commercial_use_allowed']
+      end
+
+      if attributes.key?(:'attribution')
+        self.attribution = attributes[:'attribution']
+      end
+
+      if attributes.key?(:'contains_personal_data')
+        self.contains_personal_data = attributes[:'contains_personal_data']
+      end
+
+      if attributes.key?(:'privacy_status')
+        self.privacy_status = attributes[:'privacy_status']
+      end
+
+      if attributes.key?(:'is_current_edge')
+        self.is_current_edge = attributes[:'is_current_edge']
+      end
+
+      if attributes.key?(:'current_edge_state')
+        self.current_edge_state = attributes[:'current_edge_state']
+      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 &&
+          ownership_observation_id == o.ownership_observation_id &&
+          source_observation_id == o.source_observation_id &&
+          supersedes_observation_id == o.supersedes_observation_id &&
+          superseded_by_observation_id == o.superseded_by_observation_id &&
+          superseded_by_count == o.superseded_by_count &&
+          supersession_chain_id == o.supersession_chain_id &&
+          supersession_depth == o.supersession_depth &&
+          is_chain_terminal == o.is_chain_terminal &&
+          chain_truncated == o.chain_truncated &&
+          source_system == o.source_system &&
+          source_class == o.source_class &&
+          semantic_key == o.semantic_key &&
+          relationship_type == o.relationship_type &&
+          ownership_dimension == o.ownership_dimension &&
+          directness == o.directness &&
+          owner_kind == o.owner_kind &&
+          subject_source_ref == o.subject_source_ref &&
+          subject_name == o.subject_name &&
+          subject_legal_entity_id == o.subject_legal_entity_id &&
+          subject_company_id == o.subject_company_id &&
+          subject_company_name == o.subject_company_name &&
+          subject_group_id == o.subject_group_id &&
+          subject_group_name == o.subject_group_name &&
+          subject_org_id == o.subject_org_id &&
+          subject_investor_id == o.subject_investor_id &&
+          subject_resolution_method == o.subject_resolution_method &&
+          subject_resolution_confidence == o.subject_resolution_confidence &&
+          owner_source_ref == o.owner_source_ref &&
+          owner_name == o.owner_name &&
+          owner_legal_entity_id == o.owner_legal_entity_id &&
+          owner_company_id == o.owner_company_id &&
+          owner_company_name == o.owner_company_name &&
+          owner_group_id == o.owner_group_id &&
+          owner_group_name == o.owner_group_name &&
+          owner_org_id == o.owner_org_id &&
+          owner_investor_id == o.owner_investor_id &&
+          owner_person_id == o.owner_person_id &&
+          person_link_method == o.person_link_method &&
+          person_link_conflict == o.person_link_conflict &&
+          owner_resolution_method == o.owner_resolution_method &&
+          owner_resolution_confidence == o.owner_resolution_confidence &&
+          review_state == o.review_state &&
+          stake_value_type == o.stake_value_type &&
+          percentage_basis == o.percentage_basis &&
+          stake_percent == o.stake_percent &&
+          stake_lower_percent == o.stake_lower_percent &&
+          stake_upper_percent == o.stake_upper_percent &&
+          stake_lower_inclusive == o.stake_lower_inclusive &&
+          stake_upper_inclusive == o.stake_upper_inclusive &&
+          stake_band_code == o.stake_band_code &&
+          stake_display == o.stake_display &&
+          security_title == o.security_title &&
+          shares_amount == o.shares_amount &&
+          reported_value_amount == o.reported_value_amount &&
+          reported_value_currency == o.reported_value_currency &&
+          reported_value_scale == o.reported_value_scale &&
+          announced_date == o.announced_date &&
+          effective_date == o.effective_date &&
+          filing_date == o.filing_date &&
+          as_of_date == o.as_of_date &&
+          ceased_date == o.ceased_date &&
+          observation_date == o.observation_date &&
+          observation_date_basis == o.observation_date_basis &&
+          lifecycle_status == o.lifecycle_status &&
+          source_document_id == o.source_document_id &&
+          source_url == o.source_url &&
+          source_content_hash == o.source_content_hash &&
+          evidence_quote == o.evidence_quote &&
+          restriction_tier == o.restriction_tier &&
+          source_license == o.source_license &&
+          commercial_use_allowed == o.commercial_use_allowed &&
+          attribution == o.attribution &&
+          contains_personal_data == o.contains_personal_data &&
+          privacy_status == o.privacy_status &&
+          is_current_edge == o.is_current_edge &&
+          current_edge_state == o.current_edge_state
+    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
+      [ownership_observation_id, source_observation_id, supersedes_observation_id, superseded_by_observation_id, superseded_by_count, supersession_chain_id, supersession_depth, is_chain_terminal, chain_truncated, source_system, source_class, semantic_key, relationship_type, ownership_dimension, directness, owner_kind, subject_source_ref, subject_name, subject_legal_entity_id, subject_company_id, subject_company_name, subject_group_id, subject_group_name, subject_org_id, subject_investor_id, subject_resolution_method, subject_resolution_confidence, owner_source_ref, owner_name, owner_legal_entity_id, owner_company_id, owner_company_name, owner_group_id, owner_group_name, owner_org_id, owner_investor_id, owner_person_id, person_link_method, person_link_conflict, owner_resolution_method, owner_resolution_confidence, review_state, stake_value_type, percentage_basis, stake_percent, stake_lower_percent, stake_upper_percent, stake_lower_inclusive, stake_upper_inclusive, stake_band_code, stake_display, security_title, shares_amount, reported_value_amount, reported_value_currency, reported_value_scale, announced_date, effective_date, filing_date, as_of_date, ceased_date, observation_date, observation_date_basis, lifecycle_status, source_document_id, source_url, source_content_hash, evidence_quote, restriction_tier, source_license, commercial_use_allowed, attribution, contains_personal_data, privacy_status, is_current_edge, current_edge_state].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