apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/models/contacts_response1.rb

@@ -0,0 +1,94 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # ContactsResponse1 Model.
+  class ContactsResponse1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Contact2]
+    attr_accessor :contact
+
+    # TODO: Write general description for this method
+    # @return [Array[Label]]
+    attr_accessor :labels
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contact'] = 'contact'
+      @_hash['labels'] = 'labels'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contact
+        labels
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(contact: SKIP, labels: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @contact = contact unless contact == SKIP
+      @labels = labels unless labels == 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.
+      contact = Contact2.from_hash(hash['contact']) if hash['contact']
+      # Parameter is an array, so we need to iterate through it
+      labels = nil
+      unless hash['labels'].nil?
+        labels = []
+        hash['labels'].each do |structure|
+          labels << (Label.from_hash(structure) if structure)
+        end
+      end
+
+      labels = SKIP unless hash.key?('labels')
+
+      # 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.
+      ContactsResponse1.new(contact: contact,
+                            labels: labels,
+                            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} contact: #{@contact}, labels: #{@labels}, 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} contact: #{@contact.inspect}, labels: #{@labels.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/contacts_response2.rb

@@ -0,0 +1,75 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # ContactsResponse2 Model.
+  class ContactsResponse2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Contact3]
+    attr_accessor :contact
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contact'] = 'contact'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contact
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(contact: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @contact = contact unless contact == 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.
+      contact = Contact3.from_hash(hash['contact']) if hash['contact']
+
+      # 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.
+      ContactsResponse2.new(contact: contact,
+                            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} contact: #{@contact}, 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} contact: #{@contact.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/contacts_search_request.rb

@@ -0,0 +1,166 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # ContactsSearchRequest Model.
+  class ContactsSearchRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Add a keyword search string to narrow the contacts in your team's Apollo
+    # account. Keywords should be related to the same search concept and can
+    # include names, job titles, employers or company names, or email addresses.
+    # Examples: `matthew helm`; `CEO`; `Sumware Software`
+    # @return [String]
+    attr_accessor :q_keywords
+
+    # The Apollo IDs for the contact stages that you want to include in your
+    # search results. If you add multiple contact stages, Apollo will include
+    # all contacts that match any of the stages, along with the other
+    # parameters, in the search results. Call the [List Contact Stages
+    # endpoint](https://docs.apollo.io/reference/list-contact-stages) to
+    # retrieve a list of all the contact stage IDs available in your Apollo
+    # account. Example: `6095a710bd01d100a506d4ae`
+    # @return [Array[String]]
+    attr_accessor :contact_stage_ids
+
+    # The Apollo IDs for the labels that you want to include in your search
+    # results. If you add multiple labels, Apollo will include all contacts
+    # connected to any of the labels, along with the other parameters, in the
+    # search results. Example: `['6095a710bd01d100a506d4ae']`
+    # @return [Array[String]]
+    attr_accessor :contact_label_ids
+
+    # Sort the matching contacts by 1 of the following options: 
+    # - `contact_last_activity_date`: The most recent activity date recorded
+    # first.
+    # - `contact_email_last_opened_at`: The most recent email opened date first.
+    # - `contact_email_last_clicked_at`: The most recent email clicked first.
+    # - `contact_created_at`: The most recently created first.
+    # - `contact_updated_at`: The most recently updated first.
+    # @return [String]
+    attr_accessor :sort_by_field
+
+    # Set to `true` to sort the matching contacts in ascending order. This
+    # parameter must be used with `sort_by_field`. Otherwise, the sorting logic
+    # is not applied. Example: `true`
+    # @return [TrueClass | FalseClass]
+    attr_accessor :sort_ascending
+
+    # The number of search results that should be returned for each page.
+    # Limiting the number of results per page improves the endpoint's
+    # performance. Use the `page` parameter to search the different pages of
+    # data. Example: `10`
+    # @return [Integer]
+    attr_accessor :per_page
+
+    # The page number of the Apollo data that you want to retrieve. Use this
+    # parameter in combination with the `per_page` parameter to make search
+    # results navigable and improve the performance of the endpoint. Example:
+    # `4`
+    # @return [Integer]
+    attr_accessor :page
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['q_keywords'] = 'q_keywords'
+      @_hash['contact_stage_ids'] = 'contact_stage_ids'
+      @_hash['contact_label_ids'] = 'contact_label_ids'
+      @_hash['sort_by_field'] = 'sort_by_field'
+      @_hash['sort_ascending'] = 'sort_ascending'
+      @_hash['per_page'] = 'per_page'
+      @_hash['page'] = 'page'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        q_keywords
+        contact_stage_ids
+        contact_label_ids
+        sort_by_field
+        sort_ascending
+        per_page
+        page
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(q_keywords: SKIP, contact_stage_ids: SKIP,
+                   contact_label_ids: SKIP, sort_by_field: SKIP,
+                   sort_ascending: false, per_page: SKIP, page: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @q_keywords = q_keywords unless q_keywords == SKIP
+      @contact_stage_ids = contact_stage_ids unless contact_stage_ids == SKIP
+      @contact_label_ids = contact_label_ids unless contact_label_ids == SKIP
+      @sort_by_field = sort_by_field unless sort_by_field == SKIP
+      @sort_ascending = sort_ascending unless sort_ascending == SKIP
+      @per_page = per_page unless per_page == SKIP
+      @page = page unless page == 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.
+      q_keywords = hash.key?('q_keywords') ? hash['q_keywords'] : SKIP
+      contact_stage_ids =
+        hash.key?('contact_stage_ids') ? hash['contact_stage_ids'] : SKIP
+      contact_label_ids =
+        hash.key?('contact_label_ids') ? hash['contact_label_ids'] : SKIP
+      sort_by_field = hash.key?('sort_by_field') ? hash['sort_by_field'] : SKIP
+      sort_ascending = hash['sort_ascending'] ||= false
+      per_page = hash.key?('per_page') ? hash['per_page'] : SKIP
+      page = hash.key?('page') ? hash['page'] : 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.
+      ContactsSearchRequest.new(q_keywords: q_keywords,
+                                contact_stage_ids: contact_stage_ids,
+                                contact_label_ids: contact_label_ids,
+                                sort_by_field: sort_by_field,
+                                sort_ascending: sort_ascending,
+                                per_page: per_page,
+                                page: page,
+                                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} q_keywords: #{@q_keywords}, contact_stage_ids: #{@contact_stage_ids},"\
+      " contact_label_ids: #{@contact_label_ids}, sort_by_field: #{@sort_by_field},"\
+      " sort_ascending: #{@sort_ascending}, per_page: #{@per_page}, page: #{@page},"\
+      " 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} q_keywords: #{@q_keywords.inspect}, contact_stage_ids:"\
+      " #{@contact_stage_ids.inspect}, contact_label_ids: #{@contact_label_ids.inspect},"\
+      " sort_by_field: #{@sort_by_field.inspect}, sort_ascending: #{@sort_ascending.inspect},"\
+      " per_page: #{@per_page.inspect}, page: #{@page.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/contacts_search_response.rb

@@ -0,0 +1,168 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # ContactsSearchResponse Model.
+  class ContactsSearchResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Contact5]]
+    attr_accessor :contacts
+
+    # TODO: Write general description for this method
+    # @return [Array[Breadcrumb]]
+    attr_accessor :breadcrumbs
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :partial_results_only
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_join
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :disable_eu_prospecting
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :partial_results_limit
+
+    # TODO: Write general description for this method
+    # @return [Pagination]
+    attr_accessor :pagination
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :num_fetch_result
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contacts'] = 'contacts'
+      @_hash['breadcrumbs'] = 'breadcrumbs'
+      @_hash['partial_results_only'] = 'partial_results_only'
+      @_hash['has_join'] = 'has_join'
+      @_hash['disable_eu_prospecting'] = 'disable_eu_prospecting'
+      @_hash['partial_results_limit'] = 'partial_results_limit'
+      @_hash['pagination'] = 'pagination'
+      @_hash['num_fetch_result'] = 'num_fetch_result'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contacts
+        breadcrumbs
+        partial_results_only
+        has_join
+        disable_eu_prospecting
+        partial_results_limit
+        pagination
+        num_fetch_result
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(contacts: SKIP, breadcrumbs: SKIP,
+                   partial_results_only: true, has_join: true,
+                   disable_eu_prospecting: true, partial_results_limit: 0,
+                   pagination: SKIP, num_fetch_result: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @contacts = contacts unless contacts == SKIP
+      @breadcrumbs = breadcrumbs unless breadcrumbs == SKIP
+      @partial_results_only = partial_results_only unless partial_results_only == SKIP
+      @has_join = has_join unless has_join == SKIP
+      @disable_eu_prospecting = disable_eu_prospecting unless disable_eu_prospecting == SKIP
+      @partial_results_limit = partial_results_limit unless partial_results_limit == SKIP
+      @pagination = pagination unless pagination == SKIP
+      @num_fetch_result = num_fetch_result unless num_fetch_result == 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.
+      # Parameter is an array, so we need to iterate through it
+      contacts = nil
+      unless hash['contacts'].nil?
+        contacts = []
+        hash['contacts'].each do |structure|
+          contacts << (Contact5.from_hash(structure) if structure)
+        end
+      end
+
+      contacts = SKIP unless hash.key?('contacts')
+      # Parameter is an array, so we need to iterate through it
+      breadcrumbs = nil
+      unless hash['breadcrumbs'].nil?
+        breadcrumbs = []
+        hash['breadcrumbs'].each do |structure|
+          breadcrumbs << (Breadcrumb.from_hash(structure) if structure)
+        end
+      end
+
+      breadcrumbs = SKIP unless hash.key?('breadcrumbs')
+      partial_results_only = hash['partial_results_only'] ||= true
+      has_join = hash['has_join'] ||= true
+      disable_eu_prospecting = hash['disable_eu_prospecting'] ||= true
+      partial_results_limit = hash['partial_results_limit'] ||= 0
+      pagination = Pagination.from_hash(hash['pagination']) if hash['pagination']
+      num_fetch_result =
+        hash.key?('num_fetch_result') ? hash['num_fetch_result'] : 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.
+      ContactsSearchResponse.new(contacts: contacts,
+                                 breadcrumbs: breadcrumbs,
+                                 partial_results_only: partial_results_only,
+                                 has_join: has_join,
+                                 disable_eu_prospecting: disable_eu_prospecting,
+                                 partial_results_limit: partial_results_limit,
+                                 pagination: pagination,
+                                 num_fetch_result: num_fetch_result,
+                                 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} contacts: #{@contacts}, breadcrumbs: #{@breadcrumbs}, partial_results_only:"\
+      " #{@partial_results_only}, has_join: #{@has_join}, disable_eu_prospecting:"\
+      " #{@disable_eu_prospecting}, partial_results_limit: #{@partial_results_limit}, pagination:"\
+      " #{@pagination}, num_fetch_result: #{@num_fetch_result}, 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} contacts: #{@contacts.inspect}, breadcrumbs: #{@breadcrumbs.inspect},"\
+      " partial_results_only: #{@partial_results_only.inspect}, has_join: #{@has_join.inspect},"\
+      " disable_eu_prospecting: #{@disable_eu_prospecting.inspect}, partial_results_limit:"\
+      " #{@partial_results_limit.inspect}, pagination: #{@pagination.inspect}, num_fetch_result:"\
+      " #{@num_fetch_result.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/contacts_update_owners_response.rb

@@ -0,0 +1,84 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # ContactsUpdateOwnersResponse Model.
+  class ContactsUpdateOwnersResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Contact7]]
+    attr_accessor :contacts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contacts'] = 'contacts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contacts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(contacts: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @contacts = contacts unless contacts == 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.
+      # Parameter is an array, so we need to iterate through it
+      contacts = nil
+      unless hash['contacts'].nil?
+        contacts = []
+        hash['contacts'].each do |structure|
+          contacts << (Contact7.from_hash(structure) if structure)
+        end
+      end
+
+      contacts = SKIP unless hash.key?('contacts')
+
+      # 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.
+      ContactsUpdateOwnersResponse.new(contacts: contacts,
+                                       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} contacts: #{@contacts}, 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} contacts: #{@contacts.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/contacts_update_stages_response.rb

@@ -0,0 +1,84 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # ContactsUpdateStagesResponse Model.
+  class ContactsUpdateStagesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Contact6]]
+    attr_accessor :contacts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contacts'] = 'contacts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contacts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(contacts: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @contacts = contacts unless contacts == 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.
+      # Parameter is an array, so we need to iterate through it
+      contacts = nil
+      unless hash['contacts'].nil?
+        contacts = []
+        hash['contacts'].each do |structure|
+          contacts << (Contact6.from_hash(structure) if structure)
+        end
+      end
+
+      contacts = SKIP unless hash.key?('contacts')
+
+      # 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.
+      ContactsUpdateStagesResponse.new(contacts: contacts,
+                                       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} contacts: #{@contacts}, 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} contacts: #{@contacts.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end