apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/models/sequences_request1.rb

@@ -0,0 +1,206 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # SequencesRequest1 Model.
+  class SequencesRequest1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Update the name of the sequence. Example: `New outbound sequence`
+    # @return [String]
+    attr_accessor :name
+
+    # Turn the sequence on (`true`) or off (`false`). When set to `true`, Apollo
+    # resumes scheduling for the sequence; when set to `false`, pending work is
+    # paused.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :active
+
+    # The creation type for the sequence. A `draft` sequence is automatically
+    # promoted to `new` (or `ai_assistant`) when steps are added.
+    # @return [CreationType]
+    attr_accessor :creation_type
+
+    # Update who can access the sequence. Example: `team_can_use`
+    # @return [String]
+    attr_accessor :permissions
+
+    # Attach a sending schedule to the sequence. Must reference a non-empty
+    # schedule that belongs to your team. Example: `6095a710bd01d100a506d4af`
+    # @return [String]
+    attr_accessor :emailer_schedule_id
+
+    # Replace the labels (folders) this sequence belongs to. Passing new values
+    # will overwrite the existing labels.
+    # @return [Array[String]]
+    attr_accessor :label_names
+
+    # Maximum number of emails that can be sent per day for this sequence.
+    # @return [Integer]
+    attr_accessor :max_emails_per_day
+
+    # Number of days to wait before contacting another person at the same
+    # account.
+    # @return [Integer]
+    attr_accessor :same_account_reply_delay_days
+
+    # Comma-separated list of email addresses to CC on emails sent from this
+    # sequence.
+    # @return [String]
+    attr_accessor :cc_emails
+
+    # Comma-separated list of email addresses to BCC on emails sent from this
+    # sequence.
+    # @return [String]
+    attr_accessor :bcc_emails
+
+    # The ordered list of steps in the sequence. Include an `id` to update an
+    # existing step; omit it to create a new step. Steps that exist on the
+    # sequence but are not present in this array are removed.
+    # @return [Array[EmailerStep3]]
+    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['active'] = 'active'
+      @_hash['creation_type'] = 'creation_type'
+      @_hash['permissions'] = 'permissions'
+      @_hash['emailer_schedule_id'] = 'emailer_schedule_id'
+      @_hash['label_names'] = 'label_names'
+      @_hash['max_emails_per_day'] = 'max_emails_per_day'
+      @_hash['same_account_reply_delay_days'] =
+        'same_account_reply_delay_days'
+      @_hash['cc_emails'] = 'cc_emails'
+      @_hash['bcc_emails'] = 'bcc_emails'
+      @_hash['emailer_steps'] = 'emailer_steps'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        active
+        creation_type
+        permissions
+        emailer_schedule_id
+        label_names
+        max_emails_per_day
+        same_account_reply_delay_days
+        cc_emails
+        bcc_emails
+        emailer_steps
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, active: SKIP, creation_type: SKIP,
+                   permissions: SKIP, emailer_schedule_id: SKIP,
+                   label_names: SKIP, max_emails_per_day: SKIP,
+                   same_account_reply_delay_days: SKIP, cc_emails: SKIP,
+                   bcc_emails: 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
+      @active = active unless active == SKIP
+      @creation_type = creation_type unless creation_type == SKIP
+      @permissions = permissions unless permissions == SKIP
+      @emailer_schedule_id = emailer_schedule_id unless emailer_schedule_id == SKIP
+      @label_names = label_names unless label_names == SKIP
+      @max_emails_per_day = max_emails_per_day unless max_emails_per_day == SKIP
+      unless same_account_reply_delay_days == SKIP
+        @same_account_reply_delay_days =
+          same_account_reply_delay_days
+      end
+      @cc_emails = cc_emails unless cc_emails == SKIP
+      @bcc_emails = bcc_emails unless bcc_emails == 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
+      active = hash.key?('active') ? hash['active'] : SKIP
+      creation_type = hash.key?('creation_type') ? hash['creation_type'] : SKIP
+      permissions = hash.key?('permissions') ? hash['permissions'] : SKIP
+      emailer_schedule_id =
+        hash.key?('emailer_schedule_id') ? hash['emailer_schedule_id'] : SKIP
+      label_names = hash.key?('label_names') ? hash['label_names'] : SKIP
+      max_emails_per_day =
+        hash.key?('max_emails_per_day') ? hash['max_emails_per_day'] : SKIP
+      same_account_reply_delay_days =
+        hash.key?('same_account_reply_delay_days') ? hash['same_account_reply_delay_days'] : SKIP
+      cc_emails = hash.key?('cc_emails') ? hash['cc_emails'] : SKIP
+      bcc_emails = hash.key?('bcc_emails') ? hash['bcc_emails'] : 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 << (EmailerStep3.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.
+      SequencesRequest1.new(name: name,
+                            active: active,
+                            creation_type: creation_type,
+                            permissions: permissions,
+                            emailer_schedule_id: emailer_schedule_id,
+                            label_names: label_names,
+                            max_emails_per_day: max_emails_per_day,
+                            same_account_reply_delay_days: same_account_reply_delay_days,
+                            cc_emails: cc_emails,
+                            bcc_emails: bcc_emails,
+                            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}, active: #{@active}, creation_type: #{@creation_type},"\
+      " permissions: #{@permissions}, emailer_schedule_id: #{@emailer_schedule_id}, label_names:"\
+      " #{@label_names}, max_emails_per_day: #{@max_emails_per_day},"\
+      " same_account_reply_delay_days: #{@same_account_reply_delay_days}, cc_emails:"\
+      " #{@cc_emails}, bcc_emails: #{@bcc_emails}, 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}, active: #{@active.inspect}, creation_type:"\
+      " #{@creation_type.inspect}, permissions: #{@permissions.inspect}, emailer_schedule_id:"\
+      " #{@emailer_schedule_id.inspect}, label_names: #{@label_names.inspect}, max_emails_per_day:"\
+      " #{@max_emails_per_day.inspect}, same_account_reply_delay_days:"\
+      " #{@same_account_reply_delay_days.inspect}, cc_emails: #{@cc_emails.inspect}, bcc_emails:"\
+      " #{@bcc_emails.inspect}, emailer_steps: #{@emailer_steps.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/sequences_response.rb

@@ -0,0 +1,148 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # SequencesResponse Model.
+  class SequencesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The newly created sequence, including its settings, aggregate email stats
+    # (`loading` until computed), contact status counts, and sharing
+    # permissions.
+    # @return [EmailerCampaign2]
+    attr_accessor :emailer_campaign
+
+    # The steps created in the sequence.
+    # @return [Array[EmailerStep2]]
+    attr_accessor :emailer_steps
+
+    # The email variants created for each step, with their review status and
+    # per-touch email stats.
+    # @return [Array[EmailerTouch2]]
+    attr_accessor :emailer_touches
+
+    # The email templates created or updated for the sequence's touches.
+    # @return [Array[EmailerTemplate1]]
+    attr_accessor :emailer_templates
+
+    # The email templates created or updated for the sequence's touches.
+    # @return [Array[Object]]
+    attr_accessor :attachments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['emailer_campaign'] = 'emailer_campaign'
+      @_hash['emailer_steps'] = 'emailer_steps'
+      @_hash['emailer_touches'] = 'emailer_touches'
+      @_hash['emailer_templates'] = 'emailer_templates'
+      @_hash['attachments'] = 'attachments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        emailer_campaign
+        emailer_steps
+        emailer_touches
+        emailer_templates
+        attachments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(emailer_campaign: SKIP, emailer_steps: SKIP,
+                   emailer_touches: SKIP, emailer_templates: SKIP,
+                   attachments: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @emailer_campaign = emailer_campaign unless emailer_campaign == SKIP
+      @emailer_steps = emailer_steps unless emailer_steps == SKIP
+      @emailer_touches = emailer_touches unless emailer_touches == SKIP
+      @emailer_templates = emailer_templates unless emailer_templates == SKIP
+      @attachments = attachments unless attachments == 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.
+      emailer_campaign = EmailerCampaign2.from_hash(hash['emailer_campaign']) if
+        hash['emailer_campaign']
+      # 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 << (EmailerStep2.from_hash(structure) if structure)
+        end
+      end
+
+      emailer_steps = SKIP unless hash.key?('emailer_steps')
+      # Parameter is an array, so we need to iterate through it
+      emailer_touches = nil
+      unless hash['emailer_touches'].nil?
+        emailer_touches = []
+        hash['emailer_touches'].each do |structure|
+          emailer_touches << (EmailerTouch2.from_hash(structure) if structure)
+        end
+      end
+
+      emailer_touches = SKIP unless hash.key?('emailer_touches')
+      # Parameter is an array, so we need to iterate through it
+      emailer_templates = nil
+      unless hash['emailer_templates'].nil?
+        emailer_templates = []
+        hash['emailer_templates'].each do |structure|
+          emailer_templates << (EmailerTemplate1.from_hash(structure) if structure)
+        end
+      end
+
+      emailer_templates = SKIP unless hash.key?('emailer_templates')
+      attachments = hash.key?('attachments') ? hash['attachments'] : 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.
+      SequencesResponse.new(emailer_campaign: emailer_campaign,
+                            emailer_steps: emailer_steps,
+                            emailer_touches: emailer_touches,
+                            emailer_templates: emailer_templates,
+                            attachments: attachments,
+                            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} emailer_campaign: #{@emailer_campaign}, emailer_steps: #{@emailer_steps},"\
+      " emailer_touches: #{@emailer_touches}, emailer_templates: #{@emailer_templates},"\
+      " attachments: #{@attachments}, 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} emailer_campaign: #{@emailer_campaign.inspect}, emailer_steps:"\
+      " #{@emailer_steps.inspect}, emailer_touches: #{@emailer_touches.inspect},"\
+      " emailer_templates: #{@emailer_templates.inspect}, attachments: #{@attachments.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/sequences_response1.rb

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