pepipost_gem 2.5.0 → 5.0.0

data/lib/pepipost/models/delete_subacoount.rb

@@ -0,0 +1,35 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # Deletesubaccount modal
+  class DeleteSubacoount < BaseModel
+    # The username of the subaccount
+    # @return [String]
+    attr_accessor :username
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['username'] = 'username'
+      @_hash
+    end
+
+    def initialize(username = nil)
+      @username = username
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      username = hash['username']
+
+      # Create object from extracted values.
+      DeleteSubacoount.new(username)
+    end
+  end
+end

data/lib/pepipost/models/domain_struct.rb

@@ -0,0 +1,45 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # Domain Modal
+  class DomainStruct < BaseModel
+    # The domain you wish to include in the 'From' header of your emails.
+    # @return [String]
+    attr_accessor :domain
+
+    # The subdomain which will be used for tracking opens, clicks and
+    # unsubscribe
+    # @return [String]
+    attr_accessor :envelope_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['domain'] = 'domain'
+      @_hash['envelope_name'] = 'envelopeName'
+      @_hash
+    end
+
+    def initialize(domain = nil,
+                   envelope_name = nil)
+      @domain = domain
+      @envelope_name = envelope_name
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      domain = hash['domain']
+      envelope_name = hash['envelopeName']
+
+      # Create object from extracted values.
+      DomainStruct.new(domain,
+                       envelope_name)
+    end
+  end
+end

data/lib/pepipost/models/email_struct.rb

@@ -0,0 +1,44 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # To, CC  and Bcc email Address structure
+  class EmailStruct < BaseModel
+    # Name of recipient
+    # @return [String]
+    attr_accessor :name
+
+    # Email of recipient
+    # @return [String]
+    attr_accessor :email
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['email'] = 'email'
+      @_hash
+    end
+
+    def initialize(name = nil,
+                   email = nil)
+      @name = name
+      @email = email
+    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['name']
+      email = hash['email']
+
+      # Create object from extracted values.
+      EmailStruct.new(name,
+                      email)
+    end
+  end
+end

data/lib/pepipost/models/enable_or_disable_subacoount.rb

@@ -0,0 +1,44 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # EnableDisablesubaccount modal
+  class EnableOrDisableSubacoount < BaseModel
+    # The username of the subaccount
+    # @return [String]
+    attr_accessor :username
+
+    # Flag to indicate whether the subaccount should be enabled or disabled.
+    # @return [Boolean]
+    attr_accessor :disabled
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['username'] = 'username'
+      @_hash['disabled'] = 'disabled'
+      @_hash
+    end
+
+    def initialize(username = nil,
+                   disabled = nil)
+      @username = username
+      @disabled = disabled
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      username = hash['username']
+      disabled = hash['disabled']
+
+      # Create object from extracted values.
+      EnableOrDisableSubacoount.new(username,
+                                    disabled)
+    end
+  end
+end

data/lib/pepipost/models/events_enum.rb

@@ -0,0 +1,44 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # events.
+  class EventsEnum
+    EVENTS_ENUM = [
+      # TODO: Write general description for PROCESSED
+      PROCESSED = 'processed'.freeze,
+
+      # TODO: Write general description for SENT
+      SENT = 'sent'.freeze,
+
+      # TODO: Write general description for OPEN
+      OPEN = 'open'.freeze,
+
+      # TODO: Write general description for CLICK
+      CLICK = 'click'.freeze,
+
+      # TODO: Write general description for UNSUBSCRIBE
+      UNSUBSCRIBE = 'unsubscribe'.freeze,
+
+      # TODO: Write general description for BOUNCE
+      BOUNCE = 'bounce'.freeze,
+
+      # TODO: Write general description for SOFTBOUNCE
+      SOFTBOUNCE = 'softbounce'.freeze,
+
+      # TODO: Write general description for SPAM
+      SPAM = 'spam'.freeze,
+
+      # TODO: Write general description for INVALID
+      INVALID = 'invalid'.freeze,
+
+      # TODO: Write general description for DROPPED
+      DROPPED = 'dropped'.freeze,
+
+      # TODO: Write general description for HARDBOUNCE
+      HARDBOUNCE = 'hardbounce'.freeze
+    ].freeze
+  end
+end

data/lib/pepipost/models/from.rb

@@ -0,0 +1,44 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # Email address representing the sender of the mail
+  class From < BaseModel
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :email
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email'] = 'email'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    def initialize(email = nil,
+                   name = nil)
+      @email = email
+      @name = name
+    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['email']
+      name = hash['name']
+
+      # Create object from extracted values.
+      From.new(email,
+               name)
+    end
+  end
+end

data/lib/pepipost/models/personalizations.rb

@@ -0,0 +1,135 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # Personalizations
+  class Personalizations < BaseModel
+    # Dynamic attributes
+    # @return [Object]
+    attr_accessor :attributes
+
+    # Dynamic headers attributes
+    # @return [Object]
+    attr_accessor :headers
+
+    # Attachments to individuals recipient
+    # @return [List of Attachments]
+    attr_accessor :attachments
+
+    # To email-address
+    # @return [List of EmailStruct]
+    attr_accessor :to
+
+    # CC email-address
+    # @return [List of EmailStruct]
+    attr_accessor :cc
+
+    # Bcc email-addresses
+    # @return [List of EmailStruct]
+    attr_accessor :bcc
+
+    # token to which is json string
+    # @return [String]
+    attr_accessor :token_to
+
+    # token cc which is json string
+    # @return [String]
+    attr_accessor :token_cc
+
+    # token bcc which is json string
+    # @return [String]
+    attr_accessor :token_bcc
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['attributes'] = 'attributes'
+      @_hash['headers'] = 'headers'
+      @_hash['attachments'] = 'attachments'
+      @_hash['to'] = 'to'
+      @_hash['cc'] = 'cc'
+      @_hash['bcc'] = 'bcc'
+      @_hash['token_to'] = 'token_to'
+      @_hash['token_cc'] = 'token_cc'
+      @_hash['token_bcc'] = 'token_bcc'
+      @_hash
+    end
+
+    def initialize(to = nil,
+                   attributes = nil,
+                   headers = nil,
+                   attachments = nil,
+                   cc = nil,
+                   bcc = nil,
+                   token_to = nil,
+                   token_cc = nil,
+                   token_bcc = nil)
+      @attributes = attributes
+      @headers = headers
+      @attachments = attachments
+      @to = to
+      @cc = cc
+      @bcc = bcc
+      @token_to = token_to
+      @token_cc = token_cc
+      @token_bcc = token_bcc
+    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
+      to = nil
+      unless hash['to'].nil?
+        to = []
+        hash['to'].each do |structure|
+          to << (EmailStruct.from_hash(structure) if structure)
+        end
+      end
+      attributes = hash['attributes']
+      headers = hash['headers']
+      # Parameter is an array, so we need to iterate through it
+      attachments = nil
+      unless hash['attachments'].nil?
+        attachments = []
+        hash['attachments'].each do |structure|
+          attachments << (Attachments.from_hash(structure) if structure)
+        end
+      end
+      # Parameter is an array, so we need to iterate through it
+      cc = nil
+      unless hash['cc'].nil?
+        cc = []
+        hash['cc'].each do |structure|
+          cc << (EmailStruct.from_hash(structure) if structure)
+        end
+      end
+      # Parameter is an array, so we need to iterate through it
+      bcc = nil
+      unless hash['bcc'].nil?
+        bcc = []
+        hash['bcc'].each do |structure|
+          bcc << (EmailStruct.from_hash(structure) if structure)
+        end
+      end
+      token_to = hash['token_to']
+      token_cc = hash['token_cc']
+      token_bcc = hash['token_bcc']
+
+      # Create object from extracted values.
+      Personalizations.new(to,
+                           attributes,
+                           headers,
+                           attachments,
+                           cc,
+                           bcc,
+                           token_to,
+                           token_cc,
+                           token_bcc)
+    end
+  end
+end

data/lib/pepipost/models/remove_email_or_domain_to_suppression_list.rb

@@ -0,0 +1,48 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # Remove Suppression modal
+  class RemoveEmailOrDomainToSuppressionList < BaseModel
+    # List one or more recipient domains to be removed from the suppression list
+    # here. <br>\nComma separate the values to suppress multiple recipient
+    # domains.
+    # @return [String]
+    attr_accessor :domain
+
+    # List one or more email addresses to be removed from the suppression list
+    # here. <br>\nComma separate the values to suppress multiple email
+    # addresses.
+    # @return [String]
+    attr_accessor :email
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['domain'] = 'domain'
+      @_hash['email'] = 'email'
+      @_hash
+    end
+
+    def initialize(domain = nil,
+                   email = nil)
+      @domain = domain
+      @email = email
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      domain = hash['domain']
+      email = hash['email']
+
+      # Create object from extracted values.
+      RemoveEmailOrDomainToSuppressionList.new(domain,
+                                               email)
+    end
+  end
+end