apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/models/emailer_campaign1.rb

@@ -0,0 +1,359 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApolloRestApi
+  # Complete emailer campaign object with statistics
+  class EmailerCampaign1 < 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 :archived
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :active
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :user_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :emailer_schedule_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :max_emails_per_day
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :same_account_reply_policy_cd
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :excluded_account_stage_ids
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :excluded_contact_stage_ids
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :label_ids
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :permissions
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :loaded_stats
+
+    # 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
+
+    # TODO: Write general description for this method
+    # @return [ContactStatuses]
+    attr_accessor :contact_statuses
+
+    # TODO: Write general description for this method
+    # @return [SharingPermission]
+    attr_accessor :sharing_permission
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['archived'] = 'archived'
+      @_hash['active'] = 'active'
+      @_hash['created_at'] = 'created_at'
+      @_hash['user_id'] = 'user_id'
+      @_hash['emailer_schedule_id'] = 'emailer_schedule_id'
+      @_hash['max_emails_per_day'] = 'max_emails_per_day'
+      @_hash['same_account_reply_policy_cd'] = 'same_account_reply_policy_cd'
+      @_hash['excluded_account_stage_ids'] = 'excluded_account_stage_ids'
+      @_hash['excluded_contact_stage_ids'] = 'excluded_contact_stage_ids'
+      @_hash['label_ids'] = 'label_ids'
+      @_hash['permissions'] = 'permissions'
+      @_hash['loaded_stats'] = 'loaded_stats'
+      @_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['contact_statuses'] = 'contact_statuses'
+      @_hash['sharing_permission'] = 'sharing_permission'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+        archived
+        active
+        created_at
+        user_id
+        emailer_schedule_id
+        max_emails_per_day
+        same_account_reply_policy_cd
+        excluded_account_stage_ids
+        excluded_contact_stage_ids
+        label_ids
+        permissions
+        loaded_stats
+        unique_scheduled
+        unique_delivered
+        unique_bounced
+        unique_opened
+        unique_replied
+        bounce_rate
+        open_rate
+        reply_rate
+        contact_statuses
+        sharing_permission
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        emailer_schedule_id
+        max_emails_per_day
+        same_account_reply_policy_cd
+      ]
+    end
+
+    def initialize(id: SKIP, name: SKIP, archived: SKIP, active: SKIP,
+                   created_at: SKIP, user_id: SKIP, emailer_schedule_id: SKIP,
+                   max_emails_per_day: SKIP, same_account_reply_policy_cd: SKIP,
+                   excluded_account_stage_ids: SKIP,
+                   excluded_contact_stage_ids: SKIP, label_ids: SKIP,
+                   permissions: SKIP, loaded_stats: 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, contact_statuses: SKIP,
+                   sharing_permission: 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
+      @archived = archived unless archived == SKIP
+      @active = active unless active == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @user_id = user_id unless user_id == SKIP
+      @emailer_schedule_id = emailer_schedule_id unless emailer_schedule_id == SKIP
+      @max_emails_per_day = max_emails_per_day unless max_emails_per_day == SKIP
+      unless same_account_reply_policy_cd == SKIP
+        @same_account_reply_policy_cd =
+          same_account_reply_policy_cd
+      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
+      @label_ids = label_ids unless label_ids == SKIP
+      @permissions = permissions unless permissions == SKIP
+      @loaded_stats = loaded_stats unless loaded_stats == 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
+      @contact_statuses = contact_statuses unless contact_statuses == SKIP
+      @sharing_permission = sharing_permission unless sharing_permission == 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
+      archived = hash.key?('archived') ? hash['archived'] : SKIP
+      active = hash.key?('active') ? hash['active'] : SKIP
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   else
+                     SKIP
+                   end
+      user_id = hash.key?('user_id') ? hash['user_id'] : SKIP
+      emailer_schedule_id =
+        hash.key?('emailer_schedule_id') ? hash['emailer_schedule_id'] : SKIP
+      max_emails_per_day =
+        hash.key?('max_emails_per_day') ? hash['max_emails_per_day'] : SKIP
+      same_account_reply_policy_cd =
+        hash.key?('same_account_reply_policy_cd') ? hash['same_account_reply_policy_cd'] : 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
+      label_ids = hash.key?('label_ids') ? hash['label_ids'] : SKIP
+      permissions = hash.key?('permissions') ? hash['permissions'] : SKIP
+      loaded_stats = hash.key?('loaded_stats') ? hash['loaded_stats'] : SKIP
+      unique_scheduled = hash.key?('unique_scheduled') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:EmailerCampaign1UniqueScheduled), 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
+      contact_statuses = ContactStatuses.from_hash(hash['contact_statuses']) if
+        hash['contact_statuses']
+      sharing_permission = SharingPermission.from_hash(hash['sharing_permission']) if
+        hash['sharing_permission']
+
+      # 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.
+      EmailerCampaign1.new(id: id,
+                           name: name,
+                           archived: archived,
+                           active: active,
+                           created_at: created_at,
+                           user_id: user_id,
+                           emailer_schedule_id: emailer_schedule_id,
+                           max_emails_per_day: max_emails_per_day,
+                           same_account_reply_policy_cd: same_account_reply_policy_cd,
+                           excluded_account_stage_ids: excluded_account_stage_ids,
+                           excluded_contact_stage_ids: excluded_contact_stage_ids,
+                           label_ids: label_ids,
+                           permissions: permissions,
+                           loaded_stats: loaded_stats,
+                           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,
+                           contact_statuses: contact_statuses,
+                           sharing_permission: sharing_permission,
+                           additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [EmailerCampaign1 | 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}, name: #{@name}, archived: #{@archived}, active: #{@active},"\
+      " created_at: #{@created_at}, user_id: #{@user_id}, emailer_schedule_id:"\
+      " #{@emailer_schedule_id}, max_emails_per_day: #{@max_emails_per_day},"\
+      " same_account_reply_policy_cd: #{@same_account_reply_policy_cd},"\
+      " excluded_account_stage_ids: #{@excluded_account_stage_ids}, excluded_contact_stage_ids:"\
+      " #{@excluded_contact_stage_ids}, label_ids: #{@label_ids}, permissions: #{@permissions},"\
+      " loaded_stats: #{@loaded_stats}, 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}, contact_statuses:"\
+      " #{@contact_statuses}, sharing_permission: #{@sharing_permission}, 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}, archived: #{@archived.inspect},"\
+      " active: #{@active.inspect}, created_at: #{@created_at.inspect}, user_id:"\
+      " #{@user_id.inspect}, emailer_schedule_id: #{@emailer_schedule_id.inspect},"\
+      " max_emails_per_day: #{@max_emails_per_day.inspect}, same_account_reply_policy_cd:"\
+      " #{@same_account_reply_policy_cd.inspect}, excluded_account_stage_ids:"\
+      " #{@excluded_account_stage_ids.inspect}, excluded_contact_stage_ids:"\
+      " #{@excluded_contact_stage_ids.inspect}, label_ids: #{@label_ids.inspect}, permissions:"\
+      " #{@permissions.inspect}, loaded_stats: #{@loaded_stats.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}, contact_statuses:"\
+      " #{@contact_statuses.inspect}, sharing_permission: #{@sharing_permission.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/emailer_campaign2.rb

@@ -0,0 +1,158 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # The newly created sequence, including its settings, aggregate email stats
+  # (`loading` until computed), contact status counts, and sharing permissions.
+  class EmailerCampaign2 < 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 [String]
+    attr_accessor :permissions
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :user_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :emailer_schedule_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :num_steps
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :creation_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :created_at
+
+    # 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['permissions'] = 'permissions'
+      @_hash['user_id'] = 'user_id'
+      @_hash['emailer_schedule_id'] = 'emailer_schedule_id'
+      @_hash['num_steps'] = 'num_steps'
+      @_hash['creation_type'] = 'creation_type'
+      @_hash['created_at'] = 'created_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+        active
+        permissions
+        user_id
+        emailer_schedule_id
+        num_steps
+        creation_type
+        created_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, name: SKIP, active: SKIP, permissions: SKIP,
+                   user_id: SKIP, emailer_schedule_id: SKIP, num_steps: SKIP,
+                   creation_type: SKIP, created_at: 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
+      @permissions = permissions unless permissions == SKIP
+      @user_id = user_id unless user_id == SKIP
+      @emailer_schedule_id = emailer_schedule_id unless emailer_schedule_id == SKIP
+      @num_steps = num_steps unless num_steps == SKIP
+      @creation_type = creation_type unless creation_type == SKIP
+      @created_at = created_at unless created_at == 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
+      permissions = hash.key?('permissions') ? hash['permissions'] : SKIP
+      user_id = hash.key?('user_id') ? hash['user_id'] : SKIP
+      emailer_schedule_id =
+        hash.key?('emailer_schedule_id') ? hash['emailer_schedule_id'] : SKIP
+      num_steps = hash.key?('num_steps') ? hash['num_steps'] : SKIP
+      creation_type = hash.key?('creation_type') ? hash['creation_type'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : 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.
+      EmailerCampaign2.new(id: id,
+                           name: name,
+                           active: active,
+                           permissions: permissions,
+                           user_id: user_id,
+                           emailer_schedule_id: emailer_schedule_id,
+                           num_steps: num_steps,
+                           creation_type: creation_type,
+                           created_at: created_at,
+                           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}, permissions:"\
+      " #{@permissions}, user_id: #{@user_id}, emailer_schedule_id: #{@emailer_schedule_id},"\
+      " num_steps: #{@num_steps}, creation_type: #{@creation_type}, created_at: #{@created_at},"\
+      " 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},"\
+      " permissions: #{@permissions.inspect}, user_id: #{@user_id.inspect}, emailer_schedule_id:"\
+      " #{@emailer_schedule_id.inspect}, num_steps: #{@num_steps.inspect}, creation_type:"\
+      " #{@creation_type.inspect}, created_at: #{@created_at.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/apollo_rest_api/models/emailer_campaign3.rb

@@ -0,0 +1,95 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # EmailerCampaign3 Model.
+  class EmailerCampaign3 < 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
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+        active
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, name: SKIP, active: 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
+      @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
+
+      # 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.
+      EmailerCampaign3.new(id: id,
+                           name: name,
+                           active: active,
+                           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}, 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},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end