apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/models/accounts_response1.rb

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

data/lib/apollo_rest_api/models/accounts_search_request.rb

@@ -0,0 +1,167 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # AccountsSearchRequest Model.
+  class AccountsSearchRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Add keywords to narrow the search of the accounts in your team's Apollo
+    # account. Keywords should directly match at least part of an account's
+    # name. For example, searching the keyword `marketing` might return the
+    # result `NY Marketing Unlimited`, but not `NY Market Analysts`. This
+    # parameter only searches account names, not other account fields. Examples:
+    # `apollo`; `microsoft`; `marketing`
+    # @return [String]
+    attr_accessor :q_organization_name
+
+    # The Apollo IDs for the account stages that you want to include in your
+    # search results. If you add multiple account stages, Apollo will include
+    # all accounts that match any of the stages, along with the other
+    # parameters, in the search results. Call the [List Account Stages
+    # endpoint](https://docs.apollo.io/reference/list-account-stages) to
+    # retrieve a list of all the account stage IDs available in your Apollo
+    # account. Example: `61b8e913e0f4d2012e3af74e`
+    # @return [Array[String]]
+    attr_accessor :account_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 accounts
+    # connected to any of the labels, along with the other parameters, in the
+    # search results. Example: `['6095a710bd01d100a506d4ae']`
+    # @return [Array[String]]
+    attr_accessor :account_label_ids
+
+    # Sort the matching accounts by 1 of the following options:
+    # - `account_last_activity_date`: The most recent activity date recorded
+    # first.
+    # - `account_created_at`: The most recently created first.
+    # - `account_updated_at`: The most recently updated first.
+    # @return [SortByField]
+    attr_accessor :sort_by_field
+
+    # Set to `true` to sort the matching accounts 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 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
+
+    # 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 navigate through the different
+    # pages of data. Example: `10`
+    # @return [Integer]
+    attr_accessor :per_page
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['q_organization_name'] = 'q_organization_name'
+      @_hash['account_stage_ids'] = 'account_stage_ids'
+      @_hash['account_label_ids'] = 'account_label_ids'
+      @_hash['sort_by_field'] = 'sort_by_field'
+      @_hash['sort_ascending'] = 'sort_ascending'
+      @_hash['page'] = 'page'
+      @_hash['per_page'] = 'per_page'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        q_organization_name
+        account_stage_ids
+        account_label_ids
+        sort_by_field
+        sort_ascending
+        page
+        per_page
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(q_organization_name: SKIP, account_stage_ids: SKIP,
+                   account_label_ids: SKIP, sort_by_field: SKIP,
+                   sort_ascending: false, page: SKIP, per_page: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @q_organization_name = q_organization_name unless q_organization_name == SKIP
+      @account_stage_ids = account_stage_ids unless account_stage_ids == SKIP
+      @account_label_ids = account_label_ids unless account_label_ids == SKIP
+      @sort_by_field = sort_by_field unless sort_by_field == SKIP
+      @sort_ascending = sort_ascending unless sort_ascending == SKIP
+      @page = page unless page == SKIP
+      @per_page = per_page unless per_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_organization_name =
+        hash.key?('q_organization_name') ? hash['q_organization_name'] : SKIP
+      account_stage_ids =
+        hash.key?('account_stage_ids') ? hash['account_stage_ids'] : SKIP
+      account_label_ids =
+        hash.key?('account_label_ids') ? hash['account_label_ids'] : SKIP
+      sort_by_field = hash.key?('sort_by_field') ? hash['sort_by_field'] : SKIP
+      sort_ascending = hash['sort_ascending'] ||= false
+      page = hash.key?('page') ? hash['page'] : SKIP
+      per_page = hash.key?('per_page') ? hash['per_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.
+      AccountsSearchRequest.new(q_organization_name: q_organization_name,
+                                account_stage_ids: account_stage_ids,
+                                account_label_ids: account_label_ids,
+                                sort_by_field: sort_by_field,
+                                sort_ascending: sort_ascending,
+                                page: page,
+                                per_page: per_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_organization_name: #{@q_organization_name}, account_stage_ids:"\
+      " #{@account_stage_ids}, account_label_ids: #{@account_label_ids}, sort_by_field:"\
+      " #{@sort_by_field}, sort_ascending: #{@sort_ascending}, page: #{@page}, per_page:"\
+      " #{@per_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_organization_name: #{@q_organization_name.inspect}, account_stage_ids:"\
+      " #{@account_stage_ids.inspect}, account_label_ids: #{@account_label_ids.inspect},"\
+      " sort_by_field: #{@sort_by_field.inspect}, sort_ascending: #{@sort_ascending.inspect},"\
+      " page: #{@page.inspect}, per_page: #{@per_page.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/accounts_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
+  # AccountsSearchResponse Model.
+  class AccountsSearchResponse < 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[Account4]]
+    attr_accessor :accounts
+
+    # 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['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['num_fetch_result'] = 'num_fetch_result'
+      @_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
+        num_fetch_result
+      ]
+    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,
+                   num_fetch_result: 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
+      @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
+      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']
+      # Parameter is an array, so we need to iterate through it
+      accounts = nil
+      unless hash['accounts'].nil?
+        accounts = []
+        hash['accounts'].each do |structure|
+          accounts << (Account4.from_hash(structure) if structure)
+        end
+      end
+
+      accounts = SKIP unless hash.key?('accounts')
+      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.
+      AccountsSearchResponse.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,
+                                 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} 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}, 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} 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}, num_fetch_result: #{@num_fetch_result.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/accounts_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
+  # AccountsUpdateOwnersResponse Model.
+  class AccountsUpdateOwnersResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Account7]]
+    attr_accessor :accounts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['accounts'] = 'accounts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        accounts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(accounts: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @accounts = accounts unless accounts == 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
+      accounts = nil
+      unless hash['accounts'].nil?
+        accounts = []
+        hash['accounts'].each do |structure|
+          accounts << (Account7.from_hash(structure) if structure)
+        end
+      end
+
+      accounts = SKIP unless hash.key?('accounts')
+
+      # 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.
+      AccountsUpdateOwnersResponse.new(accounts: accounts,
+                                       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} accounts: #{@accounts}, 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} accounts: #{@accounts.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/active.rb

@@ -0,0 +1,26 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # Active.
+  class Active
+    ACTIVE = [
+      # TODO: Write general description for LOADING
+      LOADING = 'loading'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACTIVE.include?(value)
+    end
+
+    def self.from_value(value, default_value = LOADING)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end