apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/models/deliverability_score.rb

@@ -0,0 +1,460 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # DeliverabilityScore Model.
+  class DeliverabilityScore < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :avg_click_rate
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :avg_daily_sent
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :avg_delivered_rate
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :avg_hard_bounce_rate
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :avg_open_rate
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :avg_reply_rate
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :avg_spam_block_rate
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :avg_unsubscribe_rate
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :click_rate_score
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :concurrency_locks
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :created_at
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :daily_email_sent_score
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :date_from
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :date_to
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :deliverability_score
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :domain_health_score
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :email_account_domain_age_score
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :email_account_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :hard_bounce_score
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :open_rate_score
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :random
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :reply_rate_score
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :spam_block_score
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :sum_clicked_count
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :sum_delivered_count
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :sum_hard_bounced_count
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :sum_opened_count
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :sum_replied_count
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :sum_sent_count
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :sum_spam_blocked_count
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :sum_unsubscribed_count
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :team_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :unsubscribe_rate_score
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :updated_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 :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :key
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['avg_click_rate'] = 'avg_click_rate'
+      @_hash['avg_daily_sent'] = 'avg_daily_sent'
+      @_hash['avg_delivered_rate'] = 'avg_delivered_rate'
+      @_hash['avg_hard_bounce_rate'] = 'avg_hard_bounce_rate'
+      @_hash['avg_open_rate'] = 'avg_open_rate'
+      @_hash['avg_reply_rate'] = 'avg_reply_rate'
+      @_hash['avg_spam_block_rate'] = 'avg_spam_block_rate'
+      @_hash['avg_unsubscribe_rate'] = 'avg_unsubscribe_rate'
+      @_hash['click_rate_score'] = 'click_rate_score'
+      @_hash['concurrency_locks'] = 'concurrency_locks'
+      @_hash['created_at'] = 'created_at'
+      @_hash['daily_email_sent_score'] = 'daily_email_sent_score'
+      @_hash['date_from'] = 'date_from'
+      @_hash['date_to'] = 'date_to'
+      @_hash['deliverability_score'] = 'deliverability_score'
+      @_hash['domain_health_score'] = 'domain_health_score'
+      @_hash['email_account_domain_age_score'] =
+        'email_account_domain_age_score'
+      @_hash['email_account_id'] = 'email_account_id'
+      @_hash['hard_bounce_score'] = 'hard_bounce_score'
+      @_hash['open_rate_score'] = 'open_rate_score'
+      @_hash['random'] = 'random'
+      @_hash['reply_rate_score'] = 'reply_rate_score'
+      @_hash['spam_block_score'] = 'spam_block_score'
+      @_hash['sum_clicked_count'] = 'sum_clicked_count'
+      @_hash['sum_delivered_count'] = 'sum_delivered_count'
+      @_hash['sum_hard_bounced_count'] = 'sum_hard_bounced_count'
+      @_hash['sum_opened_count'] = 'sum_opened_count'
+      @_hash['sum_replied_count'] = 'sum_replied_count'
+      @_hash['sum_sent_count'] = 'sum_sent_count'
+      @_hash['sum_spam_blocked_count'] = 'sum_spam_blocked_count'
+      @_hash['sum_unsubscribed_count'] = 'sum_unsubscribed_count'
+      @_hash['team_id'] = 'team_id'
+      @_hash['unsubscribe_rate_score'] = 'unsubscribe_rate_score'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['user_id'] = 'user_id'
+      @_hash['id'] = 'id'
+      @_hash['key'] = 'key'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        avg_click_rate
+        avg_daily_sent
+        avg_delivered_rate
+        avg_hard_bounce_rate
+        avg_open_rate
+        avg_reply_rate
+        avg_spam_block_rate
+        avg_unsubscribe_rate
+        click_rate_score
+        concurrency_locks
+        created_at
+        daily_email_sent_score
+        date_from
+        date_to
+        deliverability_score
+        domain_health_score
+        email_account_domain_age_score
+        email_account_id
+        hard_bounce_score
+        open_rate_score
+        random
+        reply_rate_score
+        spam_block_score
+        sum_clicked_count
+        sum_delivered_count
+        sum_hard_bounced_count
+        sum_opened_count
+        sum_replied_count
+        sum_sent_count
+        sum_spam_blocked_count
+        sum_unsubscribed_count
+        team_id
+        unsubscribe_rate_score
+        updated_at
+        user_id
+        id
+        key
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(avg_click_rate: 0, avg_daily_sent: 0, avg_delivered_rate: 0,
+                   avg_hard_bounce_rate: 0, avg_open_rate: 0, avg_reply_rate: 0,
+                   avg_spam_block_rate: 0, avg_unsubscribe_rate: 0,
+                   click_rate_score: 0, concurrency_locks: SKIP,
+                   created_at: SKIP, daily_email_sent_score: 0, date_from: SKIP,
+                   date_to: SKIP, deliverability_score: 0,
+                   domain_health_score: 0, email_account_domain_age_score: 0,
+                   email_account_id: SKIP, hard_bounce_score: 0,
+                   open_rate_score: 0, random: 0, reply_rate_score: 0,
+                   spam_block_score: 0, sum_clicked_count: 0,
+                   sum_delivered_count: 0, sum_hard_bounced_count: 0,
+                   sum_opened_count: 0, sum_replied_count: 0, sum_sent_count: 0,
+                   sum_spam_blocked_count: 0, sum_unsubscribed_count: 0,
+                   team_id: SKIP, unsubscribe_rate_score: 0, updated_at: SKIP,
+                   user_id: SKIP, id: SKIP, key: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @avg_click_rate = avg_click_rate unless avg_click_rate == SKIP
+      @avg_daily_sent = avg_daily_sent unless avg_daily_sent == SKIP
+      @avg_delivered_rate = avg_delivered_rate unless avg_delivered_rate == SKIP
+      @avg_hard_bounce_rate = avg_hard_bounce_rate unless avg_hard_bounce_rate == SKIP
+      @avg_open_rate = avg_open_rate unless avg_open_rate == SKIP
+      @avg_reply_rate = avg_reply_rate unless avg_reply_rate == SKIP
+      @avg_spam_block_rate = avg_spam_block_rate unless avg_spam_block_rate == SKIP
+      @avg_unsubscribe_rate = avg_unsubscribe_rate unless avg_unsubscribe_rate == SKIP
+      @click_rate_score = click_rate_score unless click_rate_score == SKIP
+      @concurrency_locks = concurrency_locks unless concurrency_locks == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @daily_email_sent_score = daily_email_sent_score unless daily_email_sent_score == SKIP
+      @date_from = date_from unless date_from == SKIP
+      @date_to = date_to unless date_to == SKIP
+      @deliverability_score = deliverability_score unless deliverability_score == SKIP
+      @domain_health_score = domain_health_score unless domain_health_score == SKIP
+      unless email_account_domain_age_score == SKIP
+        @email_account_domain_age_score =
+          email_account_domain_age_score
+      end
+      @email_account_id = email_account_id unless email_account_id == SKIP
+      @hard_bounce_score = hard_bounce_score unless hard_bounce_score == SKIP
+      @open_rate_score = open_rate_score unless open_rate_score == SKIP
+      @random = random unless random == SKIP
+      @reply_rate_score = reply_rate_score unless reply_rate_score == SKIP
+      @spam_block_score = spam_block_score unless spam_block_score == SKIP
+      @sum_clicked_count = sum_clicked_count unless sum_clicked_count == SKIP
+      @sum_delivered_count = sum_delivered_count unless sum_delivered_count == SKIP
+      @sum_hard_bounced_count = sum_hard_bounced_count unless sum_hard_bounced_count == SKIP
+      @sum_opened_count = sum_opened_count unless sum_opened_count == SKIP
+      @sum_replied_count = sum_replied_count unless sum_replied_count == SKIP
+      @sum_sent_count = sum_sent_count unless sum_sent_count == SKIP
+      @sum_spam_blocked_count = sum_spam_blocked_count unless sum_spam_blocked_count == SKIP
+      @sum_unsubscribed_count = sum_unsubscribed_count unless sum_unsubscribed_count == SKIP
+      @team_id = team_id unless team_id == SKIP
+      @unsubscribe_rate_score = unsubscribe_rate_score unless unsubscribe_rate_score == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+      @user_id = user_id unless user_id == SKIP
+      @id = id unless id == SKIP
+      @key = key unless key == 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.
+      avg_click_rate = hash['avg_click_rate'] ||= 0
+      avg_daily_sent = hash['avg_daily_sent'] ||= 0
+      avg_delivered_rate = hash['avg_delivered_rate'] ||= 0
+      avg_hard_bounce_rate = hash['avg_hard_bounce_rate'] ||= 0
+      avg_open_rate = hash['avg_open_rate'] ||= 0
+      avg_reply_rate = hash['avg_reply_rate'] ||= 0
+      avg_spam_block_rate = hash['avg_spam_block_rate'] ||= 0
+      avg_unsubscribe_rate = hash['avg_unsubscribe_rate'] ||= 0
+      click_rate_score = hash['click_rate_score'] ||= 0
+      concurrency_locks =
+        hash.key?('concurrency_locks') ? hash['concurrency_locks'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      daily_email_sent_score = hash['daily_email_sent_score'] ||= 0
+      date_from = hash.key?('date_from') ? hash['date_from'] : SKIP
+      date_to = hash.key?('date_to') ? hash['date_to'] : SKIP
+      deliverability_score = hash['deliverability_score'] ||= 0
+      domain_health_score = hash['domain_health_score'] ||= 0
+      email_account_domain_age_score =
+        hash['email_account_domain_age_score'] ||= 0
+      email_account_id =
+        hash.key?('email_account_id') ? hash['email_account_id'] : SKIP
+      hard_bounce_score = hash['hard_bounce_score'] ||= 0
+      open_rate_score = hash['open_rate_score'] ||= 0
+      random = hash['random'] ||= 0
+      reply_rate_score = hash['reply_rate_score'] ||= 0
+      spam_block_score = hash['spam_block_score'] ||= 0
+      sum_clicked_count = hash['sum_clicked_count'] ||= 0
+      sum_delivered_count = hash['sum_delivered_count'] ||= 0
+      sum_hard_bounced_count = hash['sum_hard_bounced_count'] ||= 0
+      sum_opened_count = hash['sum_opened_count'] ||= 0
+      sum_replied_count = hash['sum_replied_count'] ||= 0
+      sum_sent_count = hash['sum_sent_count'] ||= 0
+      sum_spam_blocked_count = hash['sum_spam_blocked_count'] ||= 0
+      sum_unsubscribed_count = hash['sum_unsubscribed_count'] ||= 0
+      team_id = hash.key?('team_id') ? hash['team_id'] : SKIP
+      unsubscribe_rate_score = hash['unsubscribe_rate_score'] ||= 0
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : SKIP
+      user_id = hash.key?('user_id') ? hash['user_id'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      key = hash.key?('key') ? hash['key'] : 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.
+      DeliverabilityScore.new(avg_click_rate: avg_click_rate,
+                              avg_daily_sent: avg_daily_sent,
+                              avg_delivered_rate: avg_delivered_rate,
+                              avg_hard_bounce_rate: avg_hard_bounce_rate,
+                              avg_open_rate: avg_open_rate,
+                              avg_reply_rate: avg_reply_rate,
+                              avg_spam_block_rate: avg_spam_block_rate,
+                              avg_unsubscribe_rate: avg_unsubscribe_rate,
+                              click_rate_score: click_rate_score,
+                              concurrency_locks: concurrency_locks,
+                              created_at: created_at,
+                              daily_email_sent_score: daily_email_sent_score,
+                              date_from: date_from,
+                              date_to: date_to,
+                              deliverability_score: deliverability_score,
+                              domain_health_score: domain_health_score,
+                              email_account_domain_age_score: email_account_domain_age_score,
+                              email_account_id: email_account_id,
+                              hard_bounce_score: hard_bounce_score,
+                              open_rate_score: open_rate_score,
+                              random: random,
+                              reply_rate_score: reply_rate_score,
+                              spam_block_score: spam_block_score,
+                              sum_clicked_count: sum_clicked_count,
+                              sum_delivered_count: sum_delivered_count,
+                              sum_hard_bounced_count: sum_hard_bounced_count,
+                              sum_opened_count: sum_opened_count,
+                              sum_replied_count: sum_replied_count,
+                              sum_sent_count: sum_sent_count,
+                              sum_spam_blocked_count: sum_spam_blocked_count,
+                              sum_unsubscribed_count: sum_unsubscribed_count,
+                              team_id: team_id,
+                              unsubscribe_rate_score: unsubscribe_rate_score,
+                              updated_at: updated_at,
+                              user_id: user_id,
+                              id: id,
+                              key: key,
+                              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} avg_click_rate: #{@avg_click_rate}, avg_daily_sent: #{@avg_daily_sent},"\
+      " avg_delivered_rate: #{@avg_delivered_rate}, avg_hard_bounce_rate:"\
+      " #{@avg_hard_bounce_rate}, avg_open_rate: #{@avg_open_rate}, avg_reply_rate:"\
+      " #{@avg_reply_rate}, avg_spam_block_rate: #{@avg_spam_block_rate}, avg_unsubscribe_rate:"\
+      " #{@avg_unsubscribe_rate}, click_rate_score: #{@click_rate_score}, concurrency_locks:"\
+      " #{@concurrency_locks}, created_at: #{@created_at}, daily_email_sent_score:"\
+      " #{@daily_email_sent_score}, date_from: #{@date_from}, date_to: #{@date_to},"\
+      " deliverability_score: #{@deliverability_score}, domain_health_score:"\
+      " #{@domain_health_score}, email_account_domain_age_score:"\
+      " #{@email_account_domain_age_score}, email_account_id: #{@email_account_id},"\
+      " hard_bounce_score: #{@hard_bounce_score}, open_rate_score: #{@open_rate_score}, random:"\
+      " #{@random}, reply_rate_score: #{@reply_rate_score}, spam_block_score:"\
+      " #{@spam_block_score}, sum_clicked_count: #{@sum_clicked_count}, sum_delivered_count:"\
+      " #{@sum_delivered_count}, sum_hard_bounced_count: #{@sum_hard_bounced_count},"\
+      " sum_opened_count: #{@sum_opened_count}, sum_replied_count: #{@sum_replied_count},"\
+      " sum_sent_count: #{@sum_sent_count}, sum_spam_blocked_count: #{@sum_spam_blocked_count},"\
+      " sum_unsubscribed_count: #{@sum_unsubscribed_count}, team_id: #{@team_id},"\
+      " unsubscribe_rate_score: #{@unsubscribe_rate_score}, updated_at: #{@updated_at}, user_id:"\
+      " #{@user_id}, id: #{@id}, key: #{@key}, 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} avg_click_rate: #{@avg_click_rate.inspect}, avg_daily_sent:"\
+      " #{@avg_daily_sent.inspect}, avg_delivered_rate: #{@avg_delivered_rate.inspect},"\
+      " avg_hard_bounce_rate: #{@avg_hard_bounce_rate.inspect}, avg_open_rate:"\
+      " #{@avg_open_rate.inspect}, avg_reply_rate: #{@avg_reply_rate.inspect},"\
+      " avg_spam_block_rate: #{@avg_spam_block_rate.inspect}, avg_unsubscribe_rate:"\
+      " #{@avg_unsubscribe_rate.inspect}, click_rate_score: #{@click_rate_score.inspect},"\
+      " concurrency_locks: #{@concurrency_locks.inspect}, created_at: #{@created_at.inspect},"\
+      " daily_email_sent_score: #{@daily_email_sent_score.inspect}, date_from:"\
+      " #{@date_from.inspect}, date_to: #{@date_to.inspect}, deliverability_score:"\
+      " #{@deliverability_score.inspect}, domain_health_score: #{@domain_health_score.inspect},"\
+      " email_account_domain_age_score: #{@email_account_domain_age_score.inspect},"\
+      " email_account_id: #{@email_account_id.inspect}, hard_bounce_score:"\
+      " #{@hard_bounce_score.inspect}, open_rate_score: #{@open_rate_score.inspect}, random:"\
+      " #{@random.inspect}, reply_rate_score: #{@reply_rate_score.inspect}, spam_block_score:"\
+      " #{@spam_block_score.inspect}, sum_clicked_count: #{@sum_clicked_count.inspect},"\
+      " sum_delivered_count: #{@sum_delivered_count.inspect}, sum_hard_bounced_count:"\
+      " #{@sum_hard_bounced_count.inspect}, sum_opened_count: #{@sum_opened_count.inspect},"\
+      " sum_replied_count: #{@sum_replied_count.inspect}, sum_sent_count:"\
+      " #{@sum_sent_count.inspect}, sum_spam_blocked_count: #{@sum_spam_blocked_count.inspect},"\
+      " sum_unsubscribed_count: #{@sum_unsubscribed_count.inspect}, team_id: #{@team_id.inspect},"\
+      " unsubscribe_rate_score: #{@unsubscribe_rate_score.inspect}, updated_at:"\
+      " #{@updated_at.inspect}, user_id: #{@user_id.inspect}, id: #{@id.inspect}, key:"\
+      " #{@key.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end