apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/models/send_from.rb

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

data/lib/apollo_rest_api/models/sequences_request.rb

@@ -0,0 +1,391 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # SequencesRequest Model.
+  class SequencesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A human-readable name for the sequence. <br><br>Example: `Q3 Outbound
+    # Outreach`
+    # @return [String]
+    attr_accessor :name
+
+    # Set who can use or view the sequence within your team. Choose 1 of the
+    # following options: <ul><li>`team_can_use`: All team members can use the
+    # sequence. (default)</li><li>`team_can_view`: Team members can view, but
+    # not use, the sequence.</li><li>`private`: Only the sequence owner can view
+    # and use the sequence.</li></ul>
+    # @return [String]
+    attr_accessor :permissions
+
+    # Set to `true` to activate the sequence immediately after creation so
+    # contacts added to it start receiving steps. If omitted or `false`, the
+    # sequence is created in an inactive state.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :active
+
+    # The Apollo ID for the schedule that controls the days and times emails are
+    # sent. The schedule must belong to your team and must not be empty.
+    # @return [String]
+    attr_accessor :emailer_schedule_id
+
+    # The Apollo user ID for the owner of the sequence. Defaults to the user
+    # that owns the API key.
+    # @return [String]
+    attr_accessor :user_id
+
+    # Add the names of lists (labels) to apply to the sequence. Labels that do
+    # not exist yet are created. <br><br>Example: `["Outbound", "Q3"]`
+    # @return [Array[String]]
+    attr_accessor :label_names
+
+    # The Apollo ID for the folder in which to place the sequence.
+    # @return [String]
+    attr_accessor :folder_id
+
+    # Set to `true` to schedule every step at an exact date and time
+    # (`exact_datetime` becomes required on each step) instead of using relative
+    # wait intervals (`wait_time`/`wait_mode`).
+    # @return [TrueClass | FalseClass]
+    attr_accessor :sequence_by_exact_daytime
+
+    # The maximum number of emails the sequence sends per day. Must not be
+    # negative.
+    # @return [Integer]
+    attr_accessor :max_emails_per_day
+
+    # Set to `true` to mark contacts as finished in the sequence when they reply
+    # to an email.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :mark_finished_if_reply
+
+    # Set to `true` to mark contacts as finished in the sequence when they click
+    # a link in an email.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :mark_finished_if_click
+
+    # Set to `true` to mark contacts as finished in the sequence when they are
+    # marked as interested.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :mark_finished_if_interested
+
+    # Set to `true` to pause contacts in the sequence when an out-of-office
+    # auto-reply is detected.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :mark_paused_if_ooo
+
+    # The number of days to wait before an incoming email is no longer treated
+    # as a response to the sequence.
+    # @return [Integer]
+    attr_accessor :days_to_wait_before_mark_as_response
+
+    # Set to `true` to automatically create a task when a contact opens an email
+    # a certain number of times. Use `email_open_trigger_task_threshold` to set
+    # the number of opens.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :create_task_if_email_open
+
+    # The number of email opens that triggers task creation when
+    # `create_task_if_email_open` is `true`.
+    # @return [Integer]
+    attr_accessor :email_open_trigger_task_threshold
+
+    # The number of days to pause other contacts at the same account after a
+    # reply is received. The maximum value is `1000`.
+    # @return [Integer]
+    attr_accessor :same_account_reply_delay_days
+
+    # The Apollo IDs for account stages to exclude from the sequence. All IDs
+    # must belong to your team.
+    # @return [Array[String]]
+    attr_accessor :excluded_account_stage_ids
+
+    # The Apollo IDs for contact stages to exclude from the sequence. All IDs
+    # must belong to your team.
+    # @return [Array[String]]
+    attr_accessor :excluded_contact_stage_ids
+
+    # Set to `true` to send emails to contacts even if their email address is on
+    # Apollo's global bounce list.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :ignore_apollo_global_email_bounce_list
+
+    # The Apollo ID for an existing sequence ruleset to apply shared sequence
+    # settings.
+    # @return [String]
+    attr_accessor :sequence_ruleset_id
+
+    # The steps to create in the sequence. Steps run in the order they appear in
+    # this array; the first item becomes the first step. There is no separate
+    # ordering field on input.
+    # @return [Array[EmailerStep1]]
+    attr_accessor :emailer_steps
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['permissions'] = 'permissions'
+      @_hash['active'] = 'active'
+      @_hash['emailer_schedule_id'] = 'emailer_schedule_id'
+      @_hash['user_id'] = 'user_id'
+      @_hash['label_names'] = 'label_names'
+      @_hash['folder_id'] = 'folder_id'
+      @_hash['sequence_by_exact_daytime'] = 'sequence_by_exact_daytime'
+      @_hash['max_emails_per_day'] = 'max_emails_per_day'
+      @_hash['mark_finished_if_reply'] = 'mark_finished_if_reply'
+      @_hash['mark_finished_if_click'] = 'mark_finished_if_click'
+      @_hash['mark_finished_if_interested'] = 'mark_finished_if_interested'
+      @_hash['mark_paused_if_ooo'] = 'mark_paused_if_ooo'
+      @_hash['days_to_wait_before_mark_as_response'] =
+        'days_to_wait_before_mark_as_response'
+      @_hash['create_task_if_email_open'] = 'create_task_if_email_open'
+      @_hash['email_open_trigger_task_threshold'] =
+        'email_open_trigger_task_threshold'
+      @_hash['same_account_reply_delay_days'] =
+        'same_account_reply_delay_days'
+      @_hash['excluded_account_stage_ids'] = 'excluded_account_stage_ids'
+      @_hash['excluded_contact_stage_ids'] = 'excluded_contact_stage_ids'
+      @_hash['ignore_apollo_global_email_bounce_list'] =
+        'ignore_apollo_global_email_bounce_list'
+      @_hash['sequence_ruleset_id'] = 'sequence_ruleset_id'
+      @_hash['emailer_steps'] = 'emailer_steps'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        permissions
+        active
+        emailer_schedule_id
+        user_id
+        label_names
+        folder_id
+        sequence_by_exact_daytime
+        max_emails_per_day
+        mark_finished_if_reply
+        mark_finished_if_click
+        mark_finished_if_interested
+        mark_paused_if_ooo
+        days_to_wait_before_mark_as_response
+        create_task_if_email_open
+        email_open_trigger_task_threshold
+        same_account_reply_delay_days
+        excluded_account_stage_ids
+        excluded_contact_stage_ids
+        ignore_apollo_global_email_bounce_list
+        sequence_ruleset_id
+        emailer_steps
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, permissions: SKIP, active: SKIP,
+                   emailer_schedule_id: SKIP, user_id: SKIP, label_names: SKIP,
+                   folder_id: SKIP, sequence_by_exact_daytime: SKIP,
+                   max_emails_per_day: SKIP, mark_finished_if_reply: SKIP,
+                   mark_finished_if_click: SKIP,
+                   mark_finished_if_interested: SKIP, mark_paused_if_ooo: SKIP,
+                   days_to_wait_before_mark_as_response: SKIP,
+                   create_task_if_email_open: SKIP,
+                   email_open_trigger_task_threshold: SKIP,
+                   same_account_reply_delay_days: SKIP,
+                   excluded_account_stage_ids: SKIP,
+                   excluded_contact_stage_ids: SKIP,
+                   ignore_apollo_global_email_bounce_list: SKIP,
+                   sequence_ruleset_id: SKIP, emailer_steps: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @permissions = permissions unless permissions == SKIP
+      @active = active unless active == SKIP
+      @emailer_schedule_id = emailer_schedule_id unless emailer_schedule_id == SKIP
+      @user_id = user_id unless user_id == SKIP
+      @label_names = label_names unless label_names == SKIP
+      @folder_id = folder_id unless folder_id == SKIP
+      unless sequence_by_exact_daytime == SKIP
+        @sequence_by_exact_daytime =
+          sequence_by_exact_daytime
+      end
+      @max_emails_per_day = max_emails_per_day unless max_emails_per_day == SKIP
+      @mark_finished_if_reply = mark_finished_if_reply unless mark_finished_if_reply == SKIP
+      @mark_finished_if_click = mark_finished_if_click unless mark_finished_if_click == SKIP
+      unless mark_finished_if_interested == SKIP
+        @mark_finished_if_interested =
+          mark_finished_if_interested
+      end
+      @mark_paused_if_ooo = mark_paused_if_ooo unless mark_paused_if_ooo == SKIP
+      unless days_to_wait_before_mark_as_response == SKIP
+        @days_to_wait_before_mark_as_response =
+          days_to_wait_before_mark_as_response
+      end
+      unless create_task_if_email_open == SKIP
+        @create_task_if_email_open =
+          create_task_if_email_open
+      end
+      unless email_open_trigger_task_threshold == SKIP
+        @email_open_trigger_task_threshold =
+          email_open_trigger_task_threshold
+      end
+      unless same_account_reply_delay_days == SKIP
+        @same_account_reply_delay_days =
+          same_account_reply_delay_days
+      end
+      unless excluded_account_stage_ids == SKIP
+        @excluded_account_stage_ids =
+          excluded_account_stage_ids
+      end
+      unless excluded_contact_stage_ids == SKIP
+        @excluded_contact_stage_ids =
+          excluded_contact_stage_ids
+      end
+      unless ignore_apollo_global_email_bounce_list == SKIP
+        @ignore_apollo_global_email_bounce_list =
+          ignore_apollo_global_email_bounce_list
+      end
+      @sequence_ruleset_id = sequence_ruleset_id unless sequence_ruleset_id == SKIP
+      @emailer_steps = emailer_steps unless emailer_steps == 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'] : SKIP
+      permissions = hash.key?('permissions') ? hash['permissions'] : SKIP
+      active = hash.key?('active') ? hash['active'] : SKIP
+      emailer_schedule_id =
+        hash.key?('emailer_schedule_id') ? hash['emailer_schedule_id'] : SKIP
+      user_id = hash.key?('user_id') ? hash['user_id'] : SKIP
+      label_names = hash.key?('label_names') ? hash['label_names'] : SKIP
+      folder_id = hash.key?('folder_id') ? hash['folder_id'] : SKIP
+      sequence_by_exact_daytime =
+        hash.key?('sequence_by_exact_daytime') ? hash['sequence_by_exact_daytime'] : SKIP
+      max_emails_per_day =
+        hash.key?('max_emails_per_day') ? hash['max_emails_per_day'] : SKIP
+      mark_finished_if_reply =
+        hash.key?('mark_finished_if_reply') ? hash['mark_finished_if_reply'] : SKIP
+      mark_finished_if_click =
+        hash.key?('mark_finished_if_click') ? hash['mark_finished_if_click'] : SKIP
+      mark_finished_if_interested =
+        hash.key?('mark_finished_if_interested') ? hash['mark_finished_if_interested'] : SKIP
+      mark_paused_if_ooo =
+        hash.key?('mark_paused_if_ooo') ? hash['mark_paused_if_ooo'] : SKIP
+      days_to_wait_before_mark_as_response =
+        hash.key?('days_to_wait_before_mark_as_response') ? hash['days_to_wait_before_mark_as_response'] : SKIP
+      create_task_if_email_open =
+        hash.key?('create_task_if_email_open') ? hash['create_task_if_email_open'] : SKIP
+      email_open_trigger_task_threshold =
+        hash.key?('email_open_trigger_task_threshold') ? hash['email_open_trigger_task_threshold'] : SKIP
+      same_account_reply_delay_days =
+        hash.key?('same_account_reply_delay_days') ? hash['same_account_reply_delay_days'] : SKIP
+      excluded_account_stage_ids =
+        hash.key?('excluded_account_stage_ids') ? hash['excluded_account_stage_ids'] : SKIP
+      excluded_contact_stage_ids =
+        hash.key?('excluded_contact_stage_ids') ? hash['excluded_contact_stage_ids'] : SKIP
+      ignore_apollo_global_email_bounce_list =
+        hash.key?('ignore_apollo_global_email_bounce_list') ? hash['ignore_apollo_global_email_bounce_list'] : SKIP
+      sequence_ruleset_id =
+        hash.key?('sequence_ruleset_id') ? hash['sequence_ruleset_id'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      emailer_steps = nil
+      unless hash['emailer_steps'].nil?
+        emailer_steps = []
+        hash['emailer_steps'].each do |structure|
+          emailer_steps << (EmailerStep1.from_hash(structure) if structure)
+        end
+      end
+
+      emailer_steps = SKIP unless hash.key?('emailer_steps')
+
+      # 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.
+      SequencesRequest.new(name: name,
+                           permissions: permissions,
+                           active: active,
+                           emailer_schedule_id: emailer_schedule_id,
+                           user_id: user_id,
+                           label_names: label_names,
+                           folder_id: folder_id,
+                           sequence_by_exact_daytime: sequence_by_exact_daytime,
+                           max_emails_per_day: max_emails_per_day,
+                           mark_finished_if_reply: mark_finished_if_reply,
+                           mark_finished_if_click: mark_finished_if_click,
+                           mark_finished_if_interested: mark_finished_if_interested,
+                           mark_paused_if_ooo: mark_paused_if_ooo,
+                           days_to_wait_before_mark_as_response: days_to_wait_before_mark_as_response,
+                           create_task_if_email_open: create_task_if_email_open,
+                           email_open_trigger_task_threshold: email_open_trigger_task_threshold,
+                           same_account_reply_delay_days: same_account_reply_delay_days,
+                           excluded_account_stage_ids: excluded_account_stage_ids,
+                           excluded_contact_stage_ids: excluded_contact_stage_ids,
+                           ignore_apollo_global_email_bounce_list: ignore_apollo_global_email_bounce_list,
+                           sequence_ruleset_id: sequence_ruleset_id,
+                           emailer_steps: emailer_steps,
+                           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}, permissions: #{@permissions}, active: #{@active},"\
+      " emailer_schedule_id: #{@emailer_schedule_id}, user_id: #{@user_id}, label_names:"\
+      " #{@label_names}, folder_id: #{@folder_id}, sequence_by_exact_daytime:"\
+      " #{@sequence_by_exact_daytime}, max_emails_per_day: #{@max_emails_per_day},"\
+      " mark_finished_if_reply: #{@mark_finished_if_reply}, mark_finished_if_click:"\
+      " #{@mark_finished_if_click}, mark_finished_if_interested: #{@mark_finished_if_interested},"\
+      " mark_paused_if_ooo: #{@mark_paused_if_ooo}, days_to_wait_before_mark_as_response:"\
+      " #{@days_to_wait_before_mark_as_response}, create_task_if_email_open:"\
+      " #{@create_task_if_email_open}, email_open_trigger_task_threshold:"\
+      " #{@email_open_trigger_task_threshold}, same_account_reply_delay_days:"\
+      " #{@same_account_reply_delay_days}, excluded_account_stage_ids:"\
+      " #{@excluded_account_stage_ids}, excluded_contact_stage_ids:"\
+      " #{@excluded_contact_stage_ids}, ignore_apollo_global_email_bounce_list:"\
+      " #{@ignore_apollo_global_email_bounce_list}, sequence_ruleset_id: #{@sequence_ruleset_id},"\
+      " emailer_steps: #{@emailer_steps}, 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}, permissions: #{@permissions.inspect}, active:"\
+      " #{@active.inspect}, emailer_schedule_id: #{@emailer_schedule_id.inspect}, user_id:"\
+      " #{@user_id.inspect}, label_names: #{@label_names.inspect}, folder_id:"\
+      " #{@folder_id.inspect}, sequence_by_exact_daytime: #{@sequence_by_exact_daytime.inspect},"\
+      " max_emails_per_day: #{@max_emails_per_day.inspect}, mark_finished_if_reply:"\
+      " #{@mark_finished_if_reply.inspect}, mark_finished_if_click:"\
+      " #{@mark_finished_if_click.inspect}, mark_finished_if_interested:"\
+      " #{@mark_finished_if_interested.inspect}, mark_paused_if_ooo:"\
+      " #{@mark_paused_if_ooo.inspect}, days_to_wait_before_mark_as_response:"\
+      " #{@days_to_wait_before_mark_as_response.inspect}, create_task_if_email_open:"\
+      " #{@create_task_if_email_open.inspect}, email_open_trigger_task_threshold:"\
+      " #{@email_open_trigger_task_threshold.inspect}, same_account_reply_delay_days:"\
+      " #{@same_account_reply_delay_days.inspect}, excluded_account_stage_ids:"\
+      " #{@excluded_account_stage_ids.inspect}, excluded_contact_stage_ids:"\
+      " #{@excluded_contact_stage_ids.inspect}, ignore_apollo_global_email_bounce_list:"\
+      " #{@ignore_apollo_global_email_bounce_list.inspect}, sequence_ruleset_id:"\
+      " #{@sequence_ruleset_id.inspect}, emailer_steps: #{@emailer_steps.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end