apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/models/label2.rb

@@ -0,0 +1,147 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # Label2 Model.
+  class Label2 < 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 :modality
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :cached_count
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :created_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :updated_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :user_id
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :book_of_business
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['modality'] = 'modality'
+      @_hash['cached_count'] = 'cached_count'
+      @_hash['name'] = 'name'
+      @_hash['created_at'] = 'created_at'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['user_id'] = 'user_id'
+      @_hash['book_of_business'] = 'book_of_business'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        modality
+        cached_count
+        name
+        created_at
+        updated_at
+        user_id
+        book_of_business
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        book_of_business
+      ]
+    end
+
+    def initialize(id: SKIP, modality: SKIP, cached_count: SKIP, name: SKIP,
+                   created_at: SKIP, updated_at: SKIP, user_id: SKIP,
+                   book_of_business: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @modality = modality unless modality == SKIP
+      @cached_count = cached_count unless cached_count == SKIP
+      @name = name unless name == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+      @user_id = user_id unless user_id == SKIP
+      @book_of_business = book_of_business unless book_of_business == 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
+      modality = hash.key?('modality') ? hash['modality'] : SKIP
+      cached_count = hash.key?('cached_count') ? hash['cached_count'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : SKIP
+      user_id = hash.key?('user_id') ? hash['user_id'] : SKIP
+      book_of_business =
+        hash.key?('book_of_business') ? hash['book_of_business'] : 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.
+      Label2.new(id: id,
+                 modality: modality,
+                 cached_count: cached_count,
+                 name: name,
+                 created_at: created_at,
+                 updated_at: updated_at,
+                 user_id: user_id,
+                 book_of_business: book_of_business,
+                 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}, modality: #{@modality}, cached_count: #{@cached_count}, name:"\
+      " #{@name}, created_at: #{@created_at}, updated_at: #{@updated_at}, user_id: #{@user_id},"\
+      " book_of_business: #{@book_of_business}, 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}, modality: #{@modality.inspect}, cached_count:"\
+      " #{@cached_count.inspect}, name: #{@name.inspect}, created_at: #{@created_at.inspect},"\
+      " updated_at: #{@updated_at.inspect}, user_id: #{@user_id.inspect}, book_of_business:"\
+      " #{@book_of_business.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/labels_add_entity_ids_to_label_names_request.rb

@@ -0,0 +1,113 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # LabelsAddEntityIdsToLabelNamesRequest Model.
+  class LabelsAddEntityIdsToLabelNamesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Apollo IDs of the contacts or accounts to add to the lists. IDs that
+    # aren't valid are ignored.<br><br>Example: `["66e34b81740c50074e3d1bd4"]`
+    # @return [Array[String]]
+    attr_accessor :entity_ids
+
+    # The names of the lists to add the records to. If a name doesn't already
+    # exist for the given `modality`, Apollo creates a new list with that
+    # name.<br><br>Example: `["Conference 2024 - Maui"]`
+    # @return [Array[String]]
+    attr_accessor :label_names
+
+    # The type of records referenced by `entity_ids`. Must be `contacts` or
+    # `accounts`.
+    # @return [Modality1]
+    attr_accessor :modality
+
+    # Controls whether the request is processed synchronously or in the
+    # background. <ul><li>`false` (default): Apollo processes the request during
+    # the API call and returns the updated lists. A synchronous request must
+    # finish within the API's 5-minute (300-second) request timeout, so a large
+    # `entity_ids` batch can time out.</li><li>`true`: Apollo processes the work
+    # in the background and immediately returns an `entity_progress_job` object
+    # — instead of the updated lists — that you can poll for progress. Use this
+    # for batches large enough to risk the 5-minute timeout.</li></ul>
+    # @return [TrueClass | FalseClass]
+    attr_accessor :async
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['entity_ids'] = 'entity_ids'
+      @_hash['label_names'] = 'label_names'
+      @_hash['modality'] = 'modality'
+      @_hash['async'] = 'async'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        async
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(entity_ids:, label_names:, modality:, async: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @entity_ids = entity_ids
+      @label_names = label_names
+      @modality = modality
+      @async = async unless async == 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.
+      entity_ids = hash.key?('entity_ids') ? hash['entity_ids'] : nil
+      label_names = hash.key?('label_names') ? hash['label_names'] : nil
+      modality = hash.key?('modality') ? hash['modality'] : nil
+      async = hash.key?('async') ? hash['async'] : 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.
+      LabelsAddEntityIdsToLabelNamesRequest.new(entity_ids: entity_ids,
+                                                label_names: label_names,
+                                                modality: modality,
+                                                async: async,
+                                                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} entity_ids: #{@entity_ids}, label_names: #{@label_names}, modality:"\
+      " #{@modality}, async: #{@async}, 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} entity_ids: #{@entity_ids.inspect}, label_names: #{@label_names.inspect},"\
+      " modality: #{@modality.inspect}, async: #{@async.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/labels_add_entity_ids_to_label_names_response.rb

@@ -0,0 +1,107 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # LabelsAddEntityIdsToLabelNamesResponse Model.
+  class LabelsAddEntityIdsToLabelNamesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Label2]]
+    attr_accessor :labels
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :message
+
+    # Returned instead of `labels` when `async` is `true`. Represents the
+    # background job processing the request; poll it to track progress.
+    # @return [EntityProgressJob2]
+    attr_accessor :entity_progress_job
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['labels'] = 'labels'
+      @_hash['message'] = 'message'
+      @_hash['entity_progress_job'] = 'entity_progress_job'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        labels
+        message
+        entity_progress_job
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(labels: SKIP, message: SKIP, entity_progress_job: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @labels = labels unless labels == SKIP
+      @message = message unless message == SKIP
+      @entity_progress_job = entity_progress_job unless entity_progress_job == 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
+      labels = nil
+      unless hash['labels'].nil?
+        labels = []
+        hash['labels'].each do |structure|
+          labels << (Label2.from_hash(structure) if structure)
+        end
+      end
+
+      labels = SKIP unless hash.key?('labels')
+      message = hash.key?('message') ? hash['message'] : SKIP
+      entity_progress_job = EntityProgressJob2.from_hash(hash['entity_progress_job']) if
+        hash['entity_progress_job']
+
+      # 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.
+      LabelsAddEntityIdsToLabelNamesResponse.new(labels: labels,
+                                                 message: message,
+                                                 entity_progress_job: entity_progress_job,
+                                                 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} labels: #{@labels}, message: #{@message}, entity_progress_job:"\
+      " #{@entity_progress_job}, 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} labels: #{@labels.inspect}, message: #{@message.inspect},"\
+      " entity_progress_job: #{@entity_progress_job.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/labels_remove_entity_ids_from_label_names_request.rb

@@ -0,0 +1,113 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # LabelsRemoveEntityIdsFromLabelNamesRequest Model.
+  class LabelsRemoveEntityIdsFromLabelNamesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Apollo IDs of the contacts or accounts to remove from the lists. IDs
+    # that aren't valid are ignored.<br><br>Example:
+    # `["66e34b81740c50074e3d1bd4"]`
+    # @return [Array[String]]
+    attr_accessor :entity_ids
+
+    # The names of the lists to remove the records from.<br><br>Example:
+    # `["Conference 2024 - Maui"]`
+    # @return [Array[String]]
+    attr_accessor :label_names
+
+    # The type of records referenced by `entity_ids`. Must be `contacts` or
+    # `accounts`.
+    # @return [Modality1]
+    attr_accessor :modality
+
+    # Controls whether the request is processed synchronously or in the
+    # background. <ul><li>`false` (default): Apollo processes the request during
+    # the API call and returns the updated lists. A synchronous request must
+    # finish within the API's 5-minute (300-second) request timeout, so a large
+    # `entity_ids` batch can time out.</li><li>`true`: Apollo processes the work
+    # in the background and immediately returns an `entity_progress_job` object
+    # — instead of the updated lists — that you can poll for progress. Use this
+    # for batches large enough to risk the 5-minute timeout.</li></ul>
+    # @return [TrueClass | FalseClass]
+    attr_accessor :async
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['entity_ids'] = 'entity_ids'
+      @_hash['label_names'] = 'label_names'
+      @_hash['modality'] = 'modality'
+      @_hash['async'] = 'async'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        async
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(entity_ids:, label_names:, modality:, async: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @entity_ids = entity_ids
+      @label_names = label_names
+      @modality = modality
+      @async = async unless async == 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.
+      entity_ids = hash.key?('entity_ids') ? hash['entity_ids'] : nil
+      label_names = hash.key?('label_names') ? hash['label_names'] : nil
+      modality = hash.key?('modality') ? hash['modality'] : nil
+      async = hash.key?('async') ? hash['async'] : 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.
+      LabelsRemoveEntityIdsFromLabelNamesRequest.new(entity_ids: entity_ids,
+                                                     label_names: label_names,
+                                                     modality: modality,
+                                                     async: async,
+                                                     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} entity_ids: #{@entity_ids}, label_names: #{@label_names}, modality:"\
+      " #{@modality}, async: #{@async}, 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} entity_ids: #{@entity_ids.inspect}, label_names: #{@label_names.inspect},"\
+      " modality: #{@modality.inspect}, async: #{@async.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/labels_remove_entity_ids_from_label_names_response.rb

@@ -0,0 +1,107 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # LabelsRemoveEntityIdsFromLabelNamesResponse Model.
+  class LabelsRemoveEntityIdsFromLabelNamesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Label2]]
+    attr_accessor :labels
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :message
+
+    # Returned instead of `labels` when `async` is `true`. Represents the
+    # background job processing the request; poll it to track progress.
+    # @return [EntityProgressJob2]
+    attr_accessor :entity_progress_job
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['labels'] = 'labels'
+      @_hash['message'] = 'message'
+      @_hash['entity_progress_job'] = 'entity_progress_job'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        labels
+        message
+        entity_progress_job
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(labels: SKIP, message: SKIP, entity_progress_job: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @labels = labels unless labels == SKIP
+      @message = message unless message == SKIP
+      @entity_progress_job = entity_progress_job unless entity_progress_job == 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
+      labels = nil
+      unless hash['labels'].nil?
+        labels = []
+        hash['labels'].each do |structure|
+          labels << (Label2.from_hash(structure) if structure)
+        end
+      end
+
+      labels = SKIP unless hash.key?('labels')
+      message = hash.key?('message') ? hash['message'] : SKIP
+      entity_progress_job = EntityProgressJob2.from_hash(hash['entity_progress_job']) if
+        hash['entity_progress_job']
+
+      # 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.
+      LabelsRemoveEntityIdsFromLabelNamesResponse.new(labels: labels,
+                                                      message: message,
+                                                      entity_progress_job: entity_progress_job,
+                                                      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} labels: #{@labels}, message: #{@message}, entity_progress_job:"\
+      " #{@entity_progress_job}, 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} labels: #{@labels.inspect}, message: #{@message.inspect},"\
+      " entity_progress_job: #{@entity_progress_job.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/labels_request.rb

@@ -0,0 +1,97 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # LabelsRequest Model.
+  class LabelsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name for the new list. Must be unique for the given `modality` within
+    # your team.<br><br>Example: `Conference 2024 - Maui`
+    # @return [String]
+    attr_accessor :name
+
+    # 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>
+    # @return [Modality]
+    attr_accessor :modality
+
+    # Set to `true` to mark an account list as a Book of Business (BoB) list.
+    # Only applies when `modality` is `accounts`. Defaults to `false`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :book_of_business
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['modality'] = 'modality'
+      @_hash['book_of_business'] = 'book_of_business'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        book_of_business
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, modality:, book_of_business: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name
+      @modality = modality
+      @book_of_business = book_of_business unless book_of_business == 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.
+      name = hash.key?('name') ? hash['name'] : nil
+      modality = hash.key?('modality') ? hash['modality'] : nil
+      book_of_business =
+        hash.key?('book_of_business') ? hash['book_of_business'] : 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.
+      LabelsRequest.new(name: name,
+                        modality: modality,
+                        book_of_business: book_of_business,
+                        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} name: #{@name}, modality: #{@modality}, book_of_business:"\
+      " #{@book_of_business}, 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} name: #{@name.inspect}, modality: #{@modality.inspect}, book_of_business:"\
+      " #{@book_of_business.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end