apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/models/person.rb

@@ -0,0 +1,393 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # Person Model.
+  class Person < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :first_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :last_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :linkedin_url
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :title
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :email_status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :photo_url
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :twitter_url
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :github_url
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :facebook_url
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :extrapolated_email_confidence
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :headline
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :email
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :organization_id
+
+    # TODO: Write general description for this method
+    # @return [Array[EmploymentHistory]]
+    attr_accessor :employment_history
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :state
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :city
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :country
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :contact_id
+
+    # TODO: Write general description for this method
+    # @return [Contact]
+    attr_accessor :contact
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :revealed_for_current_team
+
+    # TODO: Write general description for this method
+    # @return [Organization]
+    attr_accessor :organization
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_likely_to_engage
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :intent_strength
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :show_intent
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :departments
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :subdepartments
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :functions
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :seniority
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['first_name'] = 'first_name'
+      @_hash['last_name'] = 'last_name'
+      @_hash['name'] = 'name'
+      @_hash['linkedin_url'] = 'linkedin_url'
+      @_hash['title'] = 'title'
+      @_hash['email_status'] = 'email_status'
+      @_hash['photo_url'] = 'photo_url'
+      @_hash['twitter_url'] = 'twitter_url'
+      @_hash['github_url'] = 'github_url'
+      @_hash['facebook_url'] = 'facebook_url'
+      @_hash['extrapolated_email_confidence'] =
+        'extrapolated_email_confidence'
+      @_hash['headline'] = 'headline'
+      @_hash['email'] = 'email'
+      @_hash['organization_id'] = 'organization_id'
+      @_hash['employment_history'] = 'employment_history'
+      @_hash['state'] = 'state'
+      @_hash['city'] = 'city'
+      @_hash['country'] = 'country'
+      @_hash['contact_id'] = 'contact_id'
+      @_hash['contact'] = 'contact'
+      @_hash['revealed_for_current_team'] = 'revealed_for_current_team'
+      @_hash['organization'] = 'organization'
+      @_hash['is_likely_to_engage'] = 'is_likely_to_engage'
+      @_hash['intent_strength'] = 'intent_strength'
+      @_hash['show_intent'] = 'show_intent'
+      @_hash['departments'] = 'departments'
+      @_hash['subdepartments'] = 'subdepartments'
+      @_hash['functions'] = 'functions'
+      @_hash['seniority'] = 'seniority'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        first_name
+        last_name
+        name
+        linkedin_url
+        title
+        email_status
+        photo_url
+        twitter_url
+        github_url
+        facebook_url
+        extrapolated_email_confidence
+        headline
+        email
+        organization_id
+        employment_history
+        state
+        city
+        country
+        contact_id
+        contact
+        revealed_for_current_team
+        organization
+        is_likely_to_engage
+        intent_strength
+        show_intent
+        departments
+        subdepartments
+        functions
+        seniority
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        extrapolated_email_confidence
+      ]
+    end
+
+    def initialize(id: SKIP, first_name: SKIP, last_name: SKIP, name: SKIP,
+                   linkedin_url: SKIP, title: SKIP, email_status: SKIP,
+                   photo_url: SKIP, twitter_url: SKIP, github_url: SKIP,
+                   facebook_url: SKIP, extrapolated_email_confidence: SKIP,
+                   headline: SKIP, email: SKIP, organization_id: SKIP,
+                   employment_history: SKIP, state: SKIP, city: SKIP,
+                   country: SKIP, contact_id: SKIP, contact: SKIP,
+                   revealed_for_current_team: true, organization: SKIP,
+                   is_likely_to_engage: true, intent_strength: SKIP,
+                   show_intent: true, departments: SKIP, subdepartments: SKIP,
+                   functions: SKIP, seniority: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @name = name unless name == SKIP
+      @linkedin_url = linkedin_url unless linkedin_url == SKIP
+      @title = title unless title == SKIP
+      @email_status = email_status unless email_status == SKIP
+      @photo_url = photo_url unless photo_url == SKIP
+      @twitter_url = twitter_url unless twitter_url == SKIP
+      @github_url = github_url unless github_url == SKIP
+      @facebook_url = facebook_url unless facebook_url == SKIP
+      unless extrapolated_email_confidence == SKIP
+        @extrapolated_email_confidence =
+          extrapolated_email_confidence
+      end
+      @headline = headline unless headline == SKIP
+      @email = email unless email == SKIP
+      @organization_id = organization_id unless organization_id == SKIP
+      @employment_history = employment_history unless employment_history == SKIP
+      @state = state unless state == SKIP
+      @city = city unless city == SKIP
+      @country = country unless country == SKIP
+      @contact_id = contact_id unless contact_id == SKIP
+      @contact = contact unless contact == SKIP
+      unless revealed_for_current_team == SKIP
+        @revealed_for_current_team =
+          revealed_for_current_team
+      end
+      @organization = organization unless organization == SKIP
+      @is_likely_to_engage = is_likely_to_engage unless is_likely_to_engage == SKIP
+      @intent_strength = intent_strength unless intent_strength == SKIP
+      @show_intent = show_intent unless show_intent == SKIP
+      @departments = departments unless departments == SKIP
+      @subdepartments = subdepartments unless subdepartments == SKIP
+      @functions = functions unless functions == SKIP
+      @seniority = seniority unless seniority == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      linkedin_url = hash.key?('linkedin_url') ? hash['linkedin_url'] : SKIP
+      title = hash.key?('title') ? hash['title'] : SKIP
+      email_status = hash.key?('email_status') ? hash['email_status'] : SKIP
+      photo_url = hash.key?('photo_url') ? hash['photo_url'] : SKIP
+      twitter_url = hash.key?('twitter_url') ? hash['twitter_url'] : SKIP
+      github_url = hash.key?('github_url') ? hash['github_url'] : SKIP
+      facebook_url = hash.key?('facebook_url') ? hash['facebook_url'] : SKIP
+      extrapolated_email_confidence =
+        hash.key?('extrapolated_email_confidence') ? hash['extrapolated_email_confidence'] : SKIP
+      headline = hash.key?('headline') ? hash['headline'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      organization_id =
+        hash.key?('organization_id') ? hash['organization_id'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      employment_history = nil
+      unless hash['employment_history'].nil?
+        employment_history = []
+        hash['employment_history'].each do |structure|
+          employment_history << (EmploymentHistory.from_hash(structure) if structure)
+        end
+      end
+
+      employment_history = SKIP unless hash.key?('employment_history')
+      state = hash.key?('state') ? hash['state'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      contact_id = hash.key?('contact_id') ? hash['contact_id'] : SKIP
+      contact = Contact.from_hash(hash['contact']) if hash['contact']
+      revealed_for_current_team = hash['revealed_for_current_team'] ||= true
+      organization = Organization.from_hash(hash['organization']) if hash['organization']
+      is_likely_to_engage = hash['is_likely_to_engage'] ||= true
+      intent_strength =
+        hash.key?('intent_strength') ? hash['intent_strength'] : SKIP
+      show_intent = hash['show_intent'] ||= true
+      departments = hash.key?('departments') ? hash['departments'] : SKIP
+      subdepartments =
+        hash.key?('subdepartments') ? hash['subdepartments'] : SKIP
+      functions = hash.key?('functions') ? hash['functions'] : SKIP
+      seniority = hash.key?('seniority') ? hash['seniority'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Person.new(id: id,
+                 first_name: first_name,
+                 last_name: last_name,
+                 name: name,
+                 linkedin_url: linkedin_url,
+                 title: title,
+                 email_status: email_status,
+                 photo_url: photo_url,
+                 twitter_url: twitter_url,
+                 github_url: github_url,
+                 facebook_url: facebook_url,
+                 extrapolated_email_confidence: extrapolated_email_confidence,
+                 headline: headline,
+                 email: email,
+                 organization_id: organization_id,
+                 employment_history: employment_history,
+                 state: state,
+                 city: city,
+                 country: country,
+                 contact_id: contact_id,
+                 contact: contact,
+                 revealed_for_current_team: revealed_for_current_team,
+                 organization: organization,
+                 is_likely_to_engage: is_likely_to_engage,
+                 intent_strength: intent_strength,
+                 show_intent: show_intent,
+                 departments: departments,
+                 subdepartments: subdepartments,
+                 functions: functions,
+                 seniority: seniority,
+                 additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, first_name: #{@first_name}, last_name: #{@last_name}, name:"\
+      " #{@name}, linkedin_url: #{@linkedin_url}, title: #{@title}, email_status:"\
+      " #{@email_status}, photo_url: #{@photo_url}, twitter_url: #{@twitter_url}, github_url:"\
+      " #{@github_url}, facebook_url: #{@facebook_url}, extrapolated_email_confidence:"\
+      " #{@extrapolated_email_confidence}, headline: #{@headline}, email: #{@email},"\
+      " organization_id: #{@organization_id}, employment_history: #{@employment_history}, state:"\
+      " #{@state}, city: #{@city}, country: #{@country}, contact_id: #{@contact_id}, contact:"\
+      " #{@contact}, revealed_for_current_team: #{@revealed_for_current_team}, organization:"\
+      " #{@organization}, is_likely_to_engage: #{@is_likely_to_engage}, intent_strength:"\
+      " #{@intent_strength}, show_intent: #{@show_intent}, departments: #{@departments},"\
+      " subdepartments: #{@subdepartments}, functions: #{@functions}, seniority: #{@seniority},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, first_name: #{@first_name.inspect}, last_name:"\
+      " #{@last_name.inspect}, name: #{@name.inspect}, linkedin_url: #{@linkedin_url.inspect},"\
+      " title: #{@title.inspect}, email_status: #{@email_status.inspect}, photo_url:"\
+      " #{@photo_url.inspect}, twitter_url: #{@twitter_url.inspect}, github_url:"\
+      " #{@github_url.inspect}, facebook_url: #{@facebook_url.inspect},"\
+      " extrapolated_email_confidence: #{@extrapolated_email_confidence.inspect}, headline:"\
+      " #{@headline.inspect}, email: #{@email.inspect}, organization_id:"\
+      " #{@organization_id.inspect}, employment_history: #{@employment_history.inspect}, state:"\
+      " #{@state.inspect}, city: #{@city.inspect}, country: #{@country.inspect}, contact_id:"\
+      " #{@contact_id.inspect}, contact: #{@contact.inspect}, revealed_for_current_team:"\
+      " #{@revealed_for_current_team.inspect}, organization: #{@organization.inspect},"\
+      " is_likely_to_engage: #{@is_likely_to_engage.inspect}, intent_strength:"\
+      " #{@intent_strength.inspect}, show_intent: #{@show_intent.inspect}, departments:"\
+      " #{@departments.inspect}, subdepartments: #{@subdepartments.inspect}, functions:"\
+      " #{@functions.inspect}, seniority: #{@seniority.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/person1.rb

@@ -0,0 +1,196 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApolloRestApi
+  # Person1 Model.
+  class Person1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Apollo ID for the person.
+    # @return [String]
+    attr_accessor :id
+
+    # The first name of the person.
+    # @return [String]
+    attr_accessor :first_name
+
+    # The last name of the person with the middle characters obfuscated for
+    # privacy. The format shows the first 2 characters, followed by asterisks,
+    # and then the last character.
+    # @return [String]
+    attr_accessor :last_name_obfuscated
+
+    # The job title of the person. This field may be null if the person's title
+    # is not available.
+    # @return [String]
+    attr_accessor :title
+
+    # The date and time when the person's data was last refreshed in Apollo's
+    # database.
+    # @return [DateTime]
+    attr_accessor :last_refreshed_at
+
+    # Indicates whether Apollo has a verified email address for this person.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_email
+
+    # Indicates whether Apollo has city location data for this person.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_city
+
+    # Indicates whether Apollo has state location data for this person.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_state
+
+    # Indicates whether Apollo has country location data for this person.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_country
+
+    # Indicates whether Apollo has direct phone number data for this person.
+    # Returns `Yes` if available, or `Maybe: please request direct dial via
+    # people/bulk_match` if uncertain.
+    # @return [String]
+    attr_accessor :has_direct_phone
+
+    # Information about the person's current employer organization.
+    # @return [Organization4]
+    attr_accessor :organization
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['first_name'] = 'first_name'
+      @_hash['last_name_obfuscated'] = 'last_name_obfuscated'
+      @_hash['title'] = 'title'
+      @_hash['last_refreshed_at'] = 'last_refreshed_at'
+      @_hash['has_email'] = 'has_email'
+      @_hash['has_city'] = 'has_city'
+      @_hash['has_state'] = 'has_state'
+      @_hash['has_country'] = 'has_country'
+      @_hash['has_direct_phone'] = 'has_direct_phone'
+      @_hash['organization'] = 'organization'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        first_name
+        last_name_obfuscated
+        title
+        last_refreshed_at
+        has_email
+        has_city
+        has_state
+        has_country
+        has_direct_phone
+        organization
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        title
+      ]
+    end
+
+    def initialize(id: SKIP, first_name: SKIP, last_name_obfuscated: SKIP,
+                   title: SKIP, last_refreshed_at: SKIP, has_email: SKIP,
+                   has_city: SKIP, has_state: SKIP, has_country: SKIP,
+                   has_direct_phone: SKIP, organization: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @last_name_obfuscated = last_name_obfuscated unless last_name_obfuscated == SKIP
+      @title = title unless title == SKIP
+      @last_refreshed_at = last_refreshed_at unless last_refreshed_at == SKIP
+      @has_email = has_email unless has_email == SKIP
+      @has_city = has_city unless has_city == SKIP
+      @has_state = has_state unless has_state == SKIP
+      @has_country = has_country unless has_country == SKIP
+      @has_direct_phone = has_direct_phone unless has_direct_phone == SKIP
+      @organization = organization unless organization == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      last_name_obfuscated =
+        hash.key?('last_name_obfuscated') ? hash['last_name_obfuscated'] : SKIP
+      title = hash.key?('title') ? hash['title'] : SKIP
+      last_refreshed_at = if hash.key?('last_refreshed_at')
+                            (DateTimeHelper.from_rfc3339(hash['last_refreshed_at']) if hash['last_refreshed_at'])
+                          else
+                            SKIP
+                          end
+      has_email = hash.key?('has_email') ? hash['has_email'] : SKIP
+      has_city = hash.key?('has_city') ? hash['has_city'] : SKIP
+      has_state = hash.key?('has_state') ? hash['has_state'] : SKIP
+      has_country = hash.key?('has_country') ? hash['has_country'] : SKIP
+      has_direct_phone =
+        hash.key?('has_direct_phone') ? hash['has_direct_phone'] : SKIP
+      organization = Organization4.from_hash(hash['organization']) if hash['organization']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Person1.new(id: id,
+                  first_name: first_name,
+                  last_name_obfuscated: last_name_obfuscated,
+                  title: title,
+                  last_refreshed_at: last_refreshed_at,
+                  has_email: has_email,
+                  has_city: has_city,
+                  has_state: has_state,
+                  has_country: has_country,
+                  has_direct_phone: has_direct_phone,
+                  organization: organization,
+                  additional_properties: additional_properties)
+    end
+
+    def to_custom_last_refreshed_at
+      DateTimeHelper.to_rfc3339(last_refreshed_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, first_name: #{@first_name}, last_name_obfuscated:"\
+      " #{@last_name_obfuscated}, title: #{@title}, last_refreshed_at: #{@last_refreshed_at},"\
+      " has_email: #{@has_email}, has_city: #{@has_city}, has_state: #{@has_state}, has_country:"\
+      " #{@has_country}, has_direct_phone: #{@has_direct_phone}, organization: #{@organization},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, first_name: #{@first_name.inspect},"\
+      " last_name_obfuscated: #{@last_name_obfuscated.inspect}, title: #{@title.inspect},"\
+      " last_refreshed_at: #{@last_refreshed_at.inspect}, has_email: #{@has_email.inspect},"\
+      " has_city: #{@has_city.inspect}, has_state: #{@has_state.inspect}, has_country:"\
+      " #{@has_country.inspect}, has_direct_phone: #{@has_direct_phone.inspect}, organization:"\
+      " #{@organization.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end