apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/models/mixed_companies_search_response.rb

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

data/lib/apollo_rest_api/models/mixed_people_api_search_response.rb

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

data/lib/apollo_rest_api/models/modality.rb

@@ -0,0 +1,37 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # The type of records the list holds. <ul><li>`contacts`: a list of contacts
+  # (people).</li><li>`accounts`: a list of accounts (companies).</li></ul>
+  class Modality
+    MODALITY = [
+      # TODO: Write general description for CONTACTS
+      CONTACTS = 'contacts'.freeze,
+
+      # TODO: Write general description for ACCOUNTS
+      ACCOUNTS = 'accounts'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MODALITY.include?(value)
+    end
+
+    def self.from_value(value, default_value = CONTACTS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'contacts' then CONTACTS
+      when 'accounts' then ACCOUNTS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/apollo_rest_api/models/modality1.rb

@@ -0,0 +1,37 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # The type of records referenced by `entity_ids`. Must be `contacts` or
+  # `accounts`.
+  class Modality1
+    MODALITY1 = [
+      # TODO: Write general description for CONTACTS
+      CONTACTS = 'contacts'.freeze,
+
+      # TODO: Write general description for ACCOUNTS
+      ACCOUNTS = 'accounts'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MODALITY1.include?(value)
+    end
+
+    def self.from_value(value, default_value = CONTACTS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'contacts' then CONTACTS
+      when 'accounts' then ACCOUNTS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/apollo_rest_api/models/modality3.rb

@@ -0,0 +1,40 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # The modality of the custom field you want to create.  Example: `contact`
+  class Modality3
+    MODALITY3 = [
+      # TODO: Write general description for CONTACT
+      CONTACT = 'contact'.freeze,
+
+      # TODO: Write general description for ACCOUNT
+      ACCOUNT = 'account'.freeze,
+
+      # TODO: Write general description for OPPORTUNITY
+      OPPORTUNITY = 'opportunity'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MODALITY3.include?(value)
+    end
+
+    def self.from_value(value, default_value = CONTACT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'contact' then CONTACT
+      when 'account' then ACCOUNT
+      when 'opportunity' then OPPORTUNITY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/apollo_rest_api/models/note.rb

@@ -0,0 +1,260 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # Note Model.
+  class Note < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier of the note.
+    # @return [String]
+    attr_accessor :id
+
+    # The ID of the user who created the note.
+    # @return [String]
+    attr_accessor :user_id
+
+    # The content of the note.
+    # @return [String]
+    attr_accessor :content
+
+    # The timestamp when the note was last updated.
+    # @return [String]
+    attr_accessor :updated_at
+
+    # The timestamp when the note was created.
+    # @return [String]
+    attr_accessor :created_at
+
+    # The ID of the associated contact.
+    # @return [String]
+    attr_accessor :contact_id
+
+    # The ID of the associated conversation.
+    # @return [String]
+    attr_accessor :conversation_id
+
+    # The ID of the associated account.
+    # @return [String]
+    attr_accessor :account_id
+
+    # Whether the note is pinned to the top.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :pinned_to_top
+
+    # Whether this is a system-generated note.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :system
+
+    # The ID of the associated opportunity.
+    # @return [String]
+    attr_accessor :opportunity_id
+
+    # Array of associated account IDs.
+    # @return [Array[String]]
+    attr_accessor :account_ids
+
+    # Array of associated contact IDs.
+    # @return [Array[String]]
+    attr_accessor :contact_ids
+
+    # Array of associated opportunity IDs.
+    # @return [Array[String]]
+    attr_accessor :opportunity_ids
+
+    # Array of associated calendar event IDs.
+    # @return [Array[String]]
+    attr_accessor :calendar_event_ids
+
+    # Array of associated conversation IDs.
+    # @return [Array[String]]
+    attr_accessor :conversation_ids
+
+    # Whether this note is an org chart note.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_org_chart_note
+
+    # Array of associated CRM note records.
+    # @return [Array[Object]]
+    attr_accessor :crm_notes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['user_id'] = 'user_id'
+      @_hash['content'] = 'content'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['created_at'] = 'created_at'
+      @_hash['contact_id'] = 'contact_id'
+      @_hash['conversation_id'] = 'conversation_id'
+      @_hash['account_id'] = 'account_id'
+      @_hash['pinned_to_top'] = 'pinned_to_top'
+      @_hash['system'] = 'system'
+      @_hash['opportunity_id'] = 'opportunity_id'
+      @_hash['account_ids'] = 'account_ids'
+      @_hash['contact_ids'] = 'contact_ids'
+      @_hash['opportunity_ids'] = 'opportunity_ids'
+      @_hash['calendar_event_ids'] = 'calendar_event_ids'
+      @_hash['conversation_ids'] = 'conversation_ids'
+      @_hash['is_org_chart_note'] = 'is_org_chart_note'
+      @_hash['crm_notes'] = 'crm_notes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        user_id
+        content
+        updated_at
+        created_at
+        contact_id
+        conversation_id
+        account_id
+        pinned_to_top
+        system
+        opportunity_id
+        account_ids
+        contact_ids
+        opportunity_ids
+        calendar_event_ids
+        conversation_ids
+        is_org_chart_note
+        crm_notes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        contact_id
+        conversation_id
+        account_id
+        opportunity_id
+      ]
+    end
+
+    def initialize(id: SKIP, user_id: SKIP, content: SKIP, updated_at: SKIP,
+                   created_at: SKIP, contact_id: SKIP, conversation_id: SKIP,
+                   account_id: SKIP, pinned_to_top: SKIP, system: SKIP,
+                   opportunity_id: SKIP, account_ids: SKIP, contact_ids: SKIP,
+                   opportunity_ids: SKIP, calendar_event_ids: SKIP,
+                   conversation_ids: SKIP, is_org_chart_note: SKIP,
+                   crm_notes: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @user_id = user_id unless user_id == SKIP
+      @content = content unless content == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @contact_id = contact_id unless contact_id == SKIP
+      @conversation_id = conversation_id unless conversation_id == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @pinned_to_top = pinned_to_top unless pinned_to_top == SKIP
+      @system = system unless system == SKIP
+      @opportunity_id = opportunity_id unless opportunity_id == SKIP
+      @account_ids = account_ids unless account_ids == SKIP
+      @contact_ids = contact_ids unless contact_ids == SKIP
+      @opportunity_ids = opportunity_ids unless opportunity_ids == SKIP
+      @calendar_event_ids = calendar_event_ids unless calendar_event_ids == SKIP
+      @conversation_ids = conversation_ids unless conversation_ids == SKIP
+      @is_org_chart_note = is_org_chart_note unless is_org_chart_note == SKIP
+      @crm_notes = crm_notes unless crm_notes == 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
+      user_id = hash.key?('user_id') ? hash['user_id'] : SKIP
+      content = hash.key?('content') ? hash['content'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      contact_id = hash.key?('contact_id') ? hash['contact_id'] : SKIP
+      conversation_id =
+        hash.key?('conversation_id') ? hash['conversation_id'] : SKIP
+      account_id = hash.key?('account_id') ? hash['account_id'] : SKIP
+      pinned_to_top = hash.key?('pinned_to_top') ? hash['pinned_to_top'] : SKIP
+      system = hash.key?('system') ? hash['system'] : SKIP
+      opportunity_id =
+        hash.key?('opportunity_id') ? hash['opportunity_id'] : SKIP
+      account_ids = hash.key?('account_ids') ? hash['account_ids'] : SKIP
+      contact_ids = hash.key?('contact_ids') ? hash['contact_ids'] : SKIP
+      opportunity_ids =
+        hash.key?('opportunity_ids') ? hash['opportunity_ids'] : SKIP
+      calendar_event_ids =
+        hash.key?('calendar_event_ids') ? hash['calendar_event_ids'] : SKIP
+      conversation_ids =
+        hash.key?('conversation_ids') ? hash['conversation_ids'] : SKIP
+      is_org_chart_note =
+        hash.key?('is_org_chart_note') ? hash['is_org_chart_note'] : SKIP
+      crm_notes = hash.key?('crm_notes') ? hash['crm_notes'] : 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.
+      Note.new(id: id,
+               user_id: user_id,
+               content: content,
+               updated_at: updated_at,
+               created_at: created_at,
+               contact_id: contact_id,
+               conversation_id: conversation_id,
+               account_id: account_id,
+               pinned_to_top: pinned_to_top,
+               system: system,
+               opportunity_id: opportunity_id,
+               account_ids: account_ids,
+               contact_ids: contact_ids,
+               opportunity_ids: opportunity_ids,
+               calendar_event_ids: calendar_event_ids,
+               conversation_ids: conversation_ids,
+               is_org_chart_note: is_org_chart_note,
+               crm_notes: crm_notes,
+               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}, user_id: #{@user_id}, content: #{@content}, updated_at:"\
+      " #{@updated_at}, created_at: #{@created_at}, contact_id: #{@contact_id}, conversation_id:"\
+      " #{@conversation_id}, account_id: #{@account_id}, pinned_to_top: #{@pinned_to_top}, system:"\
+      " #{@system}, opportunity_id: #{@opportunity_id}, account_ids: #{@account_ids}, contact_ids:"\
+      " #{@contact_ids}, opportunity_ids: #{@opportunity_ids}, calendar_event_ids:"\
+      " #{@calendar_event_ids}, conversation_ids: #{@conversation_ids}, is_org_chart_note:"\
+      " #{@is_org_chart_note}, crm_notes: #{@crm_notes}, 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}, user_id: #{@user_id.inspect}, content:"\
+      " #{@content.inspect}, updated_at: #{@updated_at.inspect}, created_at:"\
+      " #{@created_at.inspect}, contact_id: #{@contact_id.inspect}, conversation_id:"\
+      " #{@conversation_id.inspect}, account_id: #{@account_id.inspect}, pinned_to_top:"\
+      " #{@pinned_to_top.inspect}, system: #{@system.inspect}, opportunity_id:"\
+      " #{@opportunity_id.inspect}, account_ids: #{@account_ids.inspect}, contact_ids:"\
+      " #{@contact_ids.inspect}, opportunity_ids: #{@opportunity_ids.inspect}, calendar_event_ids:"\
+      " #{@calendar_event_ids.inspect}, conversation_ids: #{@conversation_ids.inspect},"\
+      " is_org_chart_note: #{@is_org_chart_note.inspect}, crm_notes: #{@crm_notes.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end