apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/models/task_type.rb

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

data/lib/apollo_rest_api/models/tasks_bulk_create_request.rb

@@ -0,0 +1,173 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApolloRestApi
+  # TasksBulkCreateRequest Model.
+  class TasksBulkCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID for the task owner within your team's Apollo account. This is the
+    # user that will take action on the contacts. <br><br>Use the <a
+    # href="https://docs.apollo.io/reference/get-a-list-of-users"
+    # target="_blank">Get a List of Users endpoint</a> to retrieve IDs for all
+    # of the users within your Apollo account. <br><br>Example:
+    # `66302798d03b9601c7934ebf`
+    # @return [String]
+    attr_accessor :user_id
+
+    # The Apollo IDs for the contacts that you want to be on the receiving end
+    # of the action. <br><br>If you add multiple contact IDs, individual tasks
+    # will be created for each of the contacts using the same task type, due
+    # date, and other details. <br><br>To find contact IDs, call the <a
+    # href="https://docs.apollo.io/reference/search-for-contacts"
+    # target="_blank">Search for Contacts endpoint</a> and identify the `id`
+    # value for the contact. <br><br>Example: `66e34b81740c50074e3d1bd4`
+    # @return [Array[String]]
+    attr_accessor :contact_ids
+
+    # Set the task to be 1 of the following task types. This enables the task
+    # owner to know the type of action they need to take. <ul> <li> `call`: Call
+    # the contacts. </li> <li> `outreach_manual_email`: Email the contacts.
+    # </li> <li> `linkedin_step_connect`: Send a LinkedIn invitation to connect
+    # with the contacts. </li> <li> `linkedin_step_message`: Send a direct
+    # message to the contacts' LinkedIn profiles. </li> <li>
+    # `linkedin_step_view_profile`: View the contacts' LinkedIn profiles. </li>
+    # <li> `linkedin_step_interact_post`: Interact with the contacts' recent
+    # LinkedIn posts. </li> <li> `action_item`: Take generic action for the
+    # contacts. If you use this task type, Apollo recommends using the `note`
+    # parameter too. </li> </ul>
+    # @return [String]
+    attr_accessor :type
+
+    # Assign a priority to the task you are creating: <ul> <li> `high` </li>
+    # <li> `medium` </li> <li> `low` </li> </ul>
+    # @return [String]
+    attr_accessor :priority
+
+    # The status of the task being created. For future-facing tasks, you should
+    # use the `scheduled` status. <br><br>For tasks that are already completed,
+    # you can use `completed` or `skipped`. <br><br>Example: `scheduled`
+    # @return [String]
+    attr_accessor :status
+
+    # The full date and time when the task will be due. <br><br>Your entry
+    # should adhere to the <a
+    # href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6"
+    # target="_blank">ISO 8601 date-time format</a>. Apollo uses Greenwich Mean
+    # Time (GMT) by default. If you do not account for time zone differences,
+    # you could add a task due date that falls on a different day than you
+    # intended. <br><br>The value you enter can either adhere to GMT, or you can
+    # adjust the time manually by specifying in hours and minutes how much you
+    # want to offset GMT.<br><br>Example: `2025-02-15T08:10:30Z`;
+    # `2025-03-25T10:15:30+05:00`
+    # @return [DateTime]
+    attr_accessor :due_at
+
+    # Add a description for the task. This should be a human-readable message.
+    # <br><br>This parameter is not required, but it is recommended as it
+    # provides the task owner with more context on the action they need to take.
+    # <br><br>Example: `This contact expressed interest in the Sequences feature
+    # specifically. Be prepared to discuss.`
+    # @return [String]
+    attr_accessor :note
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['user_id'] = 'user_id'
+      @_hash['contact_ids'] = 'contact_ids'
+      @_hash['type'] = 'type'
+      @_hash['priority'] = 'priority'
+      @_hash['status'] = 'status'
+      @_hash['due_at'] = 'due_at'
+      @_hash['note'] = 'note'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        priority
+        note
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(user_id:, contact_ids:, type:, status:, due_at:,
+                   priority: 'medium', note: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @user_id = user_id
+      @contact_ids = contact_ids
+      @type = type
+      @priority = priority unless priority == SKIP
+      @status = status
+      @due_at = due_at
+      @note = note unless note == 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.
+      user_id = hash.key?('user_id') ? hash['user_id'] : nil
+      contact_ids = hash.key?('contact_ids') ? hash['contact_ids'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      due_at = if hash.key?('due_at')
+                 (DateTimeHelper.from_rfc3339(hash['due_at']) if hash['due_at'])
+               end
+      priority = hash['priority'] ||= 'medium'
+      note = hash.key?('note') ? hash['note'] : 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.
+      TasksBulkCreateRequest.new(user_id: user_id,
+                                 contact_ids: contact_ids,
+                                 type: type,
+                                 status: status,
+                                 due_at: due_at,
+                                 priority: priority,
+                                 note: note,
+                                 additional_properties: additional_properties)
+    end
+
+    def to_custom_due_at
+      DateTimeHelper.to_rfc3339(due_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} user_id: #{@user_id}, contact_ids: #{@contact_ids}, type: #{@type},"\
+      " priority: #{@priority}, status: #{@status}, due_at: #{@due_at}, note: #{@note},"\
+      " 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} user_id: #{@user_id.inspect}, contact_ids: #{@contact_ids.inspect}, type:"\
+      " #{@type.inspect}, priority: #{@priority.inspect}, status: #{@status.inspect}, due_at:"\
+      " #{@due_at.inspect}, note: #{@note.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/tasks_bulk_create_response.rb

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

data/lib/apollo_rest_api/models/tasks_complete_request.rb

@@ -0,0 +1,75 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # TasksCompleteRequest Model.
+  class TasksCompleteRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An optional note to record when completing the task. <br><br>Example:
+    # `Left a voicemail, will follow up next week.`
+    # @return [String]
+    attr_accessor :note
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['note'] = 'note'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        note
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(note: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @note = note unless note == 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.
+      note = hash.key?('note') ? hash['note'] : 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.
+      TasksCompleteRequest.new(note: note,
+                               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} note: #{@note}, 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} note: #{@note.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/tasks_complete_response.rb

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