pepipost_gem 2.5.0 → 5.0.0

data/lib/pepipost/models/send.rb

@@ -0,0 +1,164 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # Master modal
+  class Send < BaseModel
+    # email address which recipients can reply to.
+    # @return [String]
+    attr_accessor :reply_to
+
+    # Email address representing the sender of the mail
+    # @return [From]
+    attr_accessor :from
+
+    # Subject line of the email
+    # @return [String]
+    attr_accessor :subject
+
+    # ID of the template to be used for sending the mail
+    # @return [Long]
+    attr_accessor :template_id
+
+    # content in text/plain format
+    # @return [List of Content]
+    attr_accessor :content
+
+    # attachment information
+    # @return [List of Attachments]
+    attr_accessor :attachments
+
+    # to recipient with some personalized data like to address, attachments and
+    # attributes
+    # @return [List of Personalizations]
+    attr_accessor :personalizations
+
+    # to recipient with some personalized data like to address, attachments and
+    # attributes
+    # @return [Settings]
+    attr_accessor :settings
+
+    # define custom tags to organize your emails
+    # @return [List of String]
+    attr_accessor :tags
+
+    # define custom tags to organize your emails
+    # @return [Boolean]
+    attr_accessor :lint_payload
+
+    # schedule the time of email delivery
+    # @return [Long]
+    attr_accessor :schedule
+
+    # Global bcc can be defined here
+    # @return [List of EmailStruct]
+    attr_accessor :bcc
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reply_to'] = 'reply_to'
+      @_hash['from'] = 'from'
+      @_hash['subject'] = 'subject'
+      @_hash['template_id'] = 'template_id'
+      @_hash['content'] = 'content'
+      @_hash['attachments'] = 'attachments'
+      @_hash['personalizations'] = 'personalizations'
+      @_hash['settings'] = 'settings'
+      @_hash['tags'] = 'tags'
+      @_hash['lint_payload'] = 'lint_payload'
+      @_hash['schedule'] = 'schedule'
+      @_hash['bcc'] = 'bcc'
+      @_hash
+    end
+
+    def initialize(from = nil,
+                   subject = nil,
+                   content = nil,
+                   personalizations = nil,
+                   reply_to = nil,
+                   template_id = nil,
+                   attachments = nil,
+                   settings = nil,
+                   tags = nil,
+                   lint_payload = nil,
+                   schedule = nil,
+                   bcc = nil)
+      @reply_to = reply_to
+      @from = from
+      @subject = subject
+      @template_id = template_id
+      @content = content
+      @attachments = attachments
+      @personalizations = personalizations
+      @settings = settings
+      @tags = tags
+      @lint_payload = lint_payload
+      @schedule = schedule
+      @bcc = 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.
+      from = From.from_hash(hash['from']) if hash['from']
+      subject = hash['subject']
+      # Parameter is an array, so we need to iterate through it
+      content = nil
+      unless hash['content'].nil?
+        content = []
+        hash['content'].each do |structure|
+          content << (Content.from_hash(structure) if structure)
+        end
+      end
+      # Parameter is an array, so we need to iterate through it
+      personalizations = nil
+      unless hash['personalizations'].nil?
+        personalizations = []
+        hash['personalizations'].each do |structure|
+          personalizations << (Personalizations.from_hash(structure) if structure)
+        end
+      end
+      reply_to = hash['reply_to']
+      template_id = hash['template_id']
+      # 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
+      settings = Settings.from_hash(hash['settings']) if hash['settings']
+      tags = hash['tags']
+      lint_payload = hash['lint_payload']
+      schedule = hash['schedule']
+      # 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
+
+      # Create object from extracted values.
+      Send.new(from,
+               subject,
+               content,
+               personalizations,
+               reply_to,
+               template_id,
+               attachments,
+               settings,
+               tags,
+               lint_payload,
+               schedule,
+               bcc)
+    end
+  end
+end

data/lib/pepipost/models/settings.rb

@@ -0,0 +1,71 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # Settings Model.
+  class Settings < BaseModel
+    # enable or disable footer
+    # @return [Boolean]
+    attr_accessor :footer
+
+    # enable or disable click tracking
+    # @return [Boolean]
+    attr_accessor :click_track
+
+    # enable or disable open tracking
+    # @return [Boolean]
+    attr_accessor :open_track
+
+    # enable or disable unsubscribe tracking
+    # @return [Boolean]
+    attr_accessor :unsubscribe_track
+
+    # enable or disable unsubscribe tracking
+    # @return [Boolean]
+    attr_accessor :hepf
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['footer'] = 'footer'
+      @_hash['click_track'] = 'click_track'
+      @_hash['open_track'] = 'open_track'
+      @_hash['unsubscribe_track'] = 'unsubscribe_track'
+      @_hash['hepf'] = 'hepf'
+      @_hash
+    end
+
+    def initialize(footer = nil,
+                   click_track = nil,
+                   open_track = nil,
+                   unsubscribe_track = nil,
+                   hepf = nil)
+      @footer = footer
+      @click_track = click_track
+      @open_track = open_track
+      @unsubscribe_track = unsubscribe_track
+      @hepf = hepf
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      footer = hash['footer']
+      click_track = hash['click_track']
+      open_track = hash['open_track']
+      unsubscribe_track = hash['unsubscribe_track']
+      hepf = hash['hepf']
+
+      # Create object from extracted values.
+      Settings.new(footer,
+                   click_track,
+                   open_track,
+                   unsubscribe_track,
+                   hepf)
+    end
+  end
+end

data/lib/pepipost/models/sort_enum.rb

@@ -0,0 +1,17 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # sort.
+  class SortEnum
+    SORT_ENUM = [
+      # TODO: Write general description for ASC
+      ASC = 'asc'.freeze,
+
+      # TODO: Write general description for DESC
+      DESC = 'desc'.freeze
+    ].freeze
+  end
+end

data/lib/pepipost/models/timeperiod_enum.rb

@@ -0,0 +1,20 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # The periodic \n\nAllowed values  \"daily\", \"weekly\", \"monhtly\"
+  class TimeperiodEnum
+    TIMEPERIOD_ENUM = [
+      # TODO: Write general description for DAILY
+      DAILY = 'daily'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'weekly'.freeze,
+
+      # TODO: Write general description for MONHTLY
+      MONHTLY = 'monhtly'.freeze
+    ].freeze
+  end
+end

data/lib/pepipost/models/type_enum.rb

@@ -0,0 +1,17 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # Type.
+  class TypeEnum
+    TYPE_ENUM = [
+      # TODO: Write general description for AMP
+      AMP = 'amp'.freeze,
+
+      # TODO: Write general description for HTML
+      HTML = 'html'.freeze
+    ].freeze
+  end
+end

data/lib/pepipost/models/update_credis_of_subaccount.rb

@@ -0,0 +1,54 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # UpdateCreditaccount modal
+  class UpdateCredisOfSubaccount < BaseModel
+    # The username of the subaccount
+    # @return [String]
+    attr_accessor :username
+
+    # Indicate the action (add or subtract) to be taken.Allowed values increase,
+    # decrease
+    # @return [ActionEnum]
+    attr_accessor :action
+
+    # Amount of credits
+    # @return [Integer]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['username'] = 'username'
+      @_hash['action'] = 'action'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    def initialize(username = nil,
+                   action = nil,
+                   amount = nil)
+      @username = username
+      @action = action
+      @amount = amount
+    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']
+      action = hash['action']
+      amount = hash['amount']
+
+      # Create object from extracted values.
+      UpdateCredisOfSubaccount.new(username,
+                                   action,
+                                   amount)
+    end
+  end
+end

data/lib/pepipost/models/update_recurring_credis_of_subaccount.rb

@@ -0,0 +1,80 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # Setrecurringcreditddetails modal
+  class UpdateRecurringCredisOfSubaccount < BaseModel
+    # The username of the subaccount
+    # @return [String]
+    attr_accessor :username
+
+    # The amount to be added periodically
+    # @return [Integer]
+    attr_accessor :recurring_credit
+
+    # The periodic \n\nAllowed values  \"daily\", \"weekly\", \"monhtly\"
+    # @return [TimeperiodEnum]
+    attr_accessor :timeperiod
+
+    # The date from which the credit allocation will commence
+    # @return [String]
+    attr_accessor :start_date
+
+    # The last date of credit allocation
+    # @return [String]
+    attr_accessor :end_date
+
+    # Flag to enable or disable the recurring credit allocation
+    # @return [String]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['username'] = 'username'
+      @_hash['recurring_credit'] = 'recurring_credit'
+      @_hash['timeperiod'] = 'timeperiod'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    def initialize(username = nil,
+                   recurring_credit = nil,
+                   timeperiod = nil,
+                   start_date = nil,
+                   end_date = nil,
+                   status = nil)
+      @username = username
+      @recurring_credit = recurring_credit
+      @timeperiod = timeperiod
+      @start_date = start_date
+      @end_date = end_date
+      @status = status
+    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']
+      recurring_credit = hash['recurring_credit']
+      timeperiod = hash['timeperiod']
+      start_date = hash['start_date']
+      end_date = hash['end_date']
+      status = hash['status']
+
+      # Create object from extracted values.
+      UpdateRecurringCredisOfSubaccount.new(username,
+                                            recurring_credit,
+                                            timeperiod,
+                                            start_date,
+                                            end_date,
+                                            status)
+    end
+  end
+end

data/lib/pepipost/models/update_subaccount.rb

@@ -0,0 +1,72 @@
+# pepipost
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module Pepipost
+  # UpdateSubaccount modal
+  class UpdateSubaccount < BaseModel
+    # The username for the subaccount
+    # @return [String]
+    attr_accessor :username
+
+    # The new email address to be registered with the subaccount
+    # @return [String]
+    attr_accessor :new_email
+
+    # The new password of the subaccount
+    # @return [String]
+    attr_accessor :new_password
+
+    # reconfirm the new password for the subaccount
+    # @return [String]
+    attr_accessor :confirm_password
+
+    # Allowed values one_time_credit or unlimited by default, all subaccounts
+    # are created with credit type as unlimited.
+    # @return [String]
+    attr_accessor :credit_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['username'] = 'username'
+      @_hash['new_email'] = 'new_email'
+      @_hash['new_password'] = 'new_password'
+      @_hash['confirm_password'] = 'confirm_password'
+      @_hash['credit_type'] = 'credit_type'
+      @_hash
+    end
+
+    def initialize(username = nil,
+                   new_email = nil,
+                   new_password = nil,
+                   confirm_password = nil,
+                   credit_type = nil)
+      @username = username
+      @new_email = new_email
+      @new_password = new_password
+      @confirm_password = confirm_password
+      @credit_type = credit_type
+    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']
+      new_email = hash['new_email']
+      new_password = hash['new_password']
+      confirm_password = hash['confirm_password']
+      credit_type = hash['credit_type']
+
+      # Create object from extracted values.
+      UpdateSubaccount.new(username,
+                           new_email,
+                           new_password,
+                           confirm_password,
+                           credit_type)
+    end
+  end
+end