apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/models/emailer_touch.rb

@@ -0,0 +1,254 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # EmailerTouch Model.
+  class EmailerTouch < 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 :emailer_step_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :emailer_template_id
+
+    # TODO: Write general description for this method
+    # @return [Status3]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [Type1]
+    attr_accessor :type
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_signature
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_personalized_opener
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :template_type
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :unique_scheduled
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :unique_delivered
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :unique_bounced
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :unique_opened
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :unique_replied
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :bounce_rate
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :open_rate
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :reply_rate
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['emailer_step_id'] = 'emailer_step_id'
+      @_hash['emailer_template_id'] = 'emailer_template_id'
+      @_hash['status'] = 'status'
+      @_hash['type'] = 'type'
+      @_hash['include_signature'] = 'include_signature'
+      @_hash['has_personalized_opener'] = 'has_personalized_opener'
+      @_hash['template_type'] = 'template_type'
+      @_hash['unique_scheduled'] = 'unique_scheduled'
+      @_hash['unique_delivered'] = 'unique_delivered'
+      @_hash['unique_bounced'] = 'unique_bounced'
+      @_hash['unique_opened'] = 'unique_opened'
+      @_hash['unique_replied'] = 'unique_replied'
+      @_hash['bounce_rate'] = 'bounce_rate'
+      @_hash['open_rate'] = 'open_rate'
+      @_hash['reply_rate'] = 'reply_rate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        emailer_step_id
+        emailer_template_id
+        status
+        type
+        include_signature
+        has_personalized_opener
+        template_type
+        unique_scheduled
+        unique_delivered
+        unique_bounced
+        unique_opened
+        unique_replied
+        bounce_rate
+        open_rate
+        reply_rate
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        bounce_rate
+        open_rate
+        reply_rate
+      ]
+    end
+
+    def initialize(id: SKIP, emailer_step_id: SKIP, emailer_template_id: SKIP,
+                   status: SKIP, type: SKIP, include_signature: SKIP,
+                   has_personalized_opener: SKIP, template_type: SKIP,
+                   unique_scheduled: SKIP, unique_delivered: SKIP,
+                   unique_bounced: SKIP, unique_opened: SKIP,
+                   unique_replied: SKIP, bounce_rate: SKIP, open_rate: SKIP,
+                   reply_rate: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @emailer_step_id = emailer_step_id unless emailer_step_id == SKIP
+      @emailer_template_id = emailer_template_id unless emailer_template_id == SKIP
+      @status = status unless status == SKIP
+      @type = type unless type == SKIP
+      @include_signature = include_signature unless include_signature == SKIP
+      @has_personalized_opener = has_personalized_opener unless has_personalized_opener == SKIP
+      @template_type = template_type unless template_type == SKIP
+      @unique_scheduled = unique_scheduled unless unique_scheduled == SKIP
+      @unique_delivered = unique_delivered unless unique_delivered == SKIP
+      @unique_bounced = unique_bounced unless unique_bounced == SKIP
+      @unique_opened = unique_opened unless unique_opened == SKIP
+      @unique_replied = unique_replied unless unique_replied == SKIP
+      @bounce_rate = bounce_rate unless bounce_rate == SKIP
+      @open_rate = open_rate unless open_rate == SKIP
+      @reply_rate = reply_rate unless reply_rate == 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
+      emailer_step_id =
+        hash.key?('emailer_step_id') ? hash['emailer_step_id'] : SKIP
+      emailer_template_id =
+        hash.key?('emailer_template_id') ? hash['emailer_template_id'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      include_signature =
+        hash.key?('include_signature') ? hash['include_signature'] : SKIP
+      has_personalized_opener =
+        hash.key?('has_personalized_opener') ? hash['has_personalized_opener'] : SKIP
+      template_type = hash.key?('template_type') ? hash['template_type'] : SKIP
+      unique_scheduled = hash.key?('unique_scheduled') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:EmailerTouchUniqueScheduled), hash['unique_scheduled']
+      ) : SKIP
+      unique_delivered =
+        hash.key?('unique_delivered') ? hash['unique_delivered'] : SKIP
+      unique_bounced =
+        hash.key?('unique_bounced') ? hash['unique_bounced'] : SKIP
+      unique_opened = hash.key?('unique_opened') ? hash['unique_opened'] : SKIP
+      unique_replied =
+        hash.key?('unique_replied') ? hash['unique_replied'] : SKIP
+      bounce_rate = hash.key?('bounce_rate') ? hash['bounce_rate'] : SKIP
+      open_rate = hash.key?('open_rate') ? hash['open_rate'] : SKIP
+      reply_rate = hash.key?('reply_rate') ? hash['reply_rate'] : 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.
+      EmailerTouch.new(id: id,
+                       emailer_step_id: emailer_step_id,
+                       emailer_template_id: emailer_template_id,
+                       status: status,
+                       type: type,
+                       include_signature: include_signature,
+                       has_personalized_opener: has_personalized_opener,
+                       template_type: template_type,
+                       unique_scheduled: unique_scheduled,
+                       unique_delivered: unique_delivered,
+                       unique_bounced: unique_bounced,
+                       unique_opened: unique_opened,
+                       unique_replied: unique_replied,
+                       bounce_rate: bounce_rate,
+                       open_rate: open_rate,
+                       reply_rate: reply_rate,
+                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [EmailerTouch | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, emailer_step_id: #{@emailer_step_id}, emailer_template_id:"\
+      " #{@emailer_template_id}, status: #{@status}, type: #{@type}, include_signature:"\
+      " #{@include_signature}, has_personalized_opener: #{@has_personalized_opener},"\
+      " template_type: #{@template_type}, unique_scheduled: #{@unique_scheduled},"\
+      " unique_delivered: #{@unique_delivered}, unique_bounced: #{@unique_bounced}, unique_opened:"\
+      " #{@unique_opened}, unique_replied: #{@unique_replied}, bounce_rate: #{@bounce_rate},"\
+      " open_rate: #{@open_rate}, reply_rate: #{@reply_rate}, 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}, emailer_step_id: #{@emailer_step_id.inspect},"\
+      " emailer_template_id: #{@emailer_template_id.inspect}, status: #{@status.inspect}, type:"\
+      " #{@type.inspect}, include_signature: #{@include_signature.inspect},"\
+      " has_personalized_opener: #{@has_personalized_opener.inspect}, template_type:"\
+      " #{@template_type.inspect}, unique_scheduled: #{@unique_scheduled.inspect},"\
+      " unique_delivered: #{@unique_delivered.inspect}, unique_bounced:"\
+      " #{@unique_bounced.inspect}, unique_opened: #{@unique_opened.inspect}, unique_replied:"\
+      " #{@unique_replied.inspect}, bounce_rate: #{@bounce_rate.inspect}, open_rate:"\
+      " #{@open_rate.inspect}, reply_rate: #{@reply_rate.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/emailer_touch1.rb

@@ -0,0 +1,128 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # EmailerTouch1 Model.
+  class EmailerTouch1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # How the email threads with earlier steps. Choose 1 of the following
+    # options: <ul><li>`new_thread`: Start a new email
+    # thread.</li><li>`reply_to_thread`: Reply to the thread started by a
+    # previous step. A `reply_to_thread` touch must come after a step that
+    # starts a new thread.</li></ul>
+    # @return [String]
+    attr_accessor :type
+
+    # The review status of the touch. Choose 1 of the following options:
+    # <ul><li>`approved`: The touch is approved and will be sent. Requires a
+    # template with a non-empty body.</li><li>`to_be_reviewed`: The touch
+    # requires review before it sends. (default)</li></ul>
+    # @return [String]
+    attr_accessor :status
+
+    # Set to `true` to append the sending user's email signature to the email.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_signature
+
+    # The email content for the touch. Provide `id` to update an existing
+    # template that your team owns, or omit `id` to create a new template.
+    # @return [EmailerTemplate]
+    attr_accessor :emailer_template
+
+    # The Apollo IDs for attachments to include with the email.
+    # @return [Array[String]]
+    attr_accessor :attachment_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['status'] = 'status'
+      @_hash['include_signature'] = 'include_signature'
+      @_hash['emailer_template'] = 'emailer_template'
+      @_hash['attachment_ids'] = 'attachment_ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        status
+        include_signature
+        emailer_template
+        attachment_ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type: SKIP, status: SKIP, include_signature: SKIP,
+                   emailer_template: SKIP, attachment_ids: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type unless type == SKIP
+      @status = status unless status == SKIP
+      @include_signature = include_signature unless include_signature == SKIP
+      @emailer_template = emailer_template unless emailer_template == SKIP
+      @attachment_ids = attachment_ids unless attachment_ids == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      include_signature =
+        hash.key?('include_signature') ? hash['include_signature'] : SKIP
+      emailer_template = EmailerTemplate.from_hash(hash['emailer_template']) if
+        hash['emailer_template']
+      attachment_ids =
+        hash.key?('attachment_ids') ? hash['attachment_ids'] : 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.
+      EmailerTouch1.new(type: type,
+                        status: status,
+                        include_signature: include_signature,
+                        emailer_template: emailer_template,
+                        attachment_ids: attachment_ids,
+                        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} type: #{@type}, status: #{@status}, include_signature:"\
+      " #{@include_signature}, emailer_template: #{@emailer_template}, attachment_ids:"\
+      " #{@attachment_ids}, 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} type: #{@type.inspect}, status: #{@status.inspect}, include_signature:"\
+      " #{@include_signature.inspect}, emailer_template: #{@emailer_template.inspect},"\
+      " attachment_ids: #{@attachment_ids.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/emailer_touch2.rb

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

data/lib/apollo_rest_api/models/emailer_touch3.rb

@@ -0,0 +1,139 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # EmailerTouch3 Model.
+  class EmailerTouch3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Apollo ID of an existing touch to update. Omit to create a new touch.
+    # @return [String]
+    attr_accessor :id
+
+    # The review status of the touch. Set to `approved` to enable the touch (the
+    # template must have a non-empty body).
+    # @return [Status4]
+    attr_accessor :status
+
+    # IDs of attachments to include with this touch.
+    # @return [Array[String]]
+    attr_accessor :attachment_ids
+
+    # The email template content for this touch.
+    # @return [EmailerTemplate2]
+    attr_accessor :emailer_template
+
+    # AI generation options used to compose the touch content.
+    # @return [Array[GenerationOption]]
+    attr_accessor :generation_options
+
+    # The tone to apply when generating the touch content with AI.
+    # @return [GenerationTone]
+    attr_accessor :generation_tone
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['status'] = 'status'
+      @_hash['attachment_ids'] = 'attachment_ids'
+      @_hash['emailer_template'] = 'emailer_template'
+      @_hash['generation_options'] = 'generation_options'
+      @_hash['generation_tone'] = 'generation_tone'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        status
+        attachment_ids
+        emailer_template
+        generation_options
+        generation_tone
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, status: SKIP, attachment_ids: SKIP,
+                   emailer_template: SKIP, generation_options: SKIP,
+                   generation_tone: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @status = status unless status == SKIP
+      @attachment_ids = attachment_ids unless attachment_ids == SKIP
+      @emailer_template = emailer_template unless emailer_template == SKIP
+      @generation_options = generation_options unless generation_options == SKIP
+      @generation_tone = generation_tone unless generation_tone == 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
+      status = hash.key?('status') ? hash['status'] : SKIP
+      attachment_ids =
+        hash.key?('attachment_ids') ? hash['attachment_ids'] : SKIP
+      emailer_template = EmailerTemplate2.from_hash(hash['emailer_template']) if
+        hash['emailer_template']
+      # Parameter is an array, so we need to iterate through it
+      generation_options = nil
+      unless hash['generation_options'].nil?
+        generation_options = []
+        hash['generation_options'].each do |structure|
+          generation_options << (GenerationOption.from_hash(structure) if structure)
+        end
+      end
+
+      generation_options = SKIP unless hash.key?('generation_options')
+      generation_tone = GenerationTone.from_hash(hash['generation_tone']) if
+        hash['generation_tone']
+
+      # 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.
+      EmailerTouch3.new(id: id,
+                        status: status,
+                        attachment_ids: attachment_ids,
+                        emailer_template: emailer_template,
+                        generation_options: generation_options,
+                        generation_tone: generation_tone,
+                        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}, status: #{@status}, attachment_ids: #{@attachment_ids},"\
+      " emailer_template: #{@emailer_template}, generation_options: #{@generation_options},"\
+      " generation_tone: #{@generation_tone}, 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}, status: #{@status.inspect}, attachment_ids:"\
+      " #{@attachment_ids.inspect}, emailer_template: #{@emailer_template.inspect},"\
+      " generation_options: #{@generation_options.inspect}, generation_tone:"\
+      " #{@generation_tone.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end