brevo-ruby 1.0.0

data/lib/brevo-ruby/models/get_campaign_recipients.rb

@@ -0,0 +1,207 @@
+=begin
+#Brevo API
+
+#Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/getbrevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  | 
+
+OpenAPI spec version: 3.0.0
+Contact: contact@brevo.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.19
+
+=end
+
+require 'date'
+
+module BrevoRuby
+  class GetCampaignRecipients
+    attr_accessor :lists
+
+    attr_accessor :exclusion_lists
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'lists' => :'lists',
+        :'exclusion_lists' => :'exclusionLists'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'lists' => :'Array<Integer>',
+        :'exclusion_lists' => :'Array<Integer>'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'lists')
+        if (value = attributes[:'lists']).is_a?(Array)
+          self.lists = value
+        end
+      end
+
+      if attributes.has_key?(:'exclusionLists')
+        if (value = attributes[:'exclusionLists']).is_a?(Array)
+          self.exclusion_lists = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @lists.nil?
+        invalid_properties.push('invalid value for "lists", lists cannot be nil.')
+      end
+
+      if @exclusion_lists.nil?
+        invalid_properties.push('invalid value for "exclusion_lists", exclusion_lists cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @lists.nil?
+      return false if @exclusion_lists.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          lists == o.lists &&
+          exclusion_lists == o.exclusion_lists
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [lists, exclusion_lists].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = BrevoRuby.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/brevo-ruby/models/get_campaign_stats.rb

@@ -0,0 +1,390 @@
+=begin
+#Brevo API
+
+#Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/getbrevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  | 
+
+OpenAPI spec version: 3.0.0
+Contact: contact@brevo.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.19
+
+=end
+
+require 'date'
+
+module BrevoRuby
+  class GetCampaignStats
+    # List Id of email campaign (only in case of get email campaign(s)(not for global stats))
+    attr_accessor :list_id
+
+    # Number of unique clicks for the campaign
+    attr_accessor :unique_clicks
+
+    # Number of total clicks for the campaign
+    attr_accessor :clickers
+
+    # Number of complaints (Spam reports) for the campaign
+    attr_accessor :complaints
+
+    # Number of delivered emails for the campaign
+    attr_accessor :delivered
+
+    # Number of sent emails for the campaign
+    attr_accessor :sent
+
+    # Number of softbounce for the campaign
+    attr_accessor :soft_bounces
+
+    # Number of harbounce for the campaign
+    attr_accessor :hard_bounces
+
+    # Number of unique openings for the campaign
+    attr_accessor :unique_views
+
+    # Recipients without any privacy protection option enabled in their email client
+    attr_accessor :trackable_views
+
+    # Rate of recipients without any privacy protection option enabled in their email client
+    attr_accessor :trackable_views_rate
+
+    # Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails
+    attr_accessor :estimated_views
+
+    # Number of unsubscription for the campaign
+    attr_accessor :unsubscriptions
+
+    # Number of openings for the campaign
+    attr_accessor :viewed
+
+    # Number of deferred emails for the campaign
+    attr_accessor :deferred
+
+    # Total number of non-delivered campaigns for a particular campaign id.
+    attr_accessor :return_bounce
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'list_id' => :'listId',
+        :'unique_clicks' => :'uniqueClicks',
+        :'clickers' => :'clickers',
+        :'complaints' => :'complaints',
+        :'delivered' => :'delivered',
+        :'sent' => :'sent',
+        :'soft_bounces' => :'softBounces',
+        :'hard_bounces' => :'hardBounces',
+        :'unique_views' => :'uniqueViews',
+        :'trackable_views' => :'trackableViews',
+        :'trackable_views_rate' => :'trackableViewsRate',
+        :'estimated_views' => :'estimatedViews',
+        :'unsubscriptions' => :'unsubscriptions',
+        :'viewed' => :'viewed',
+        :'deferred' => :'deferred',
+        :'return_bounce' => :'returnBounce'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'list_id' => :'Integer',
+        :'unique_clicks' => :'Integer',
+        :'clickers' => :'Integer',
+        :'complaints' => :'Integer',
+        :'delivered' => :'Integer',
+        :'sent' => :'Integer',
+        :'soft_bounces' => :'Integer',
+        :'hard_bounces' => :'Integer',
+        :'unique_views' => :'Integer',
+        :'trackable_views' => :'Integer',
+        :'trackable_views_rate' => :'Float',
+        :'estimated_views' => :'Integer',
+        :'unsubscriptions' => :'Integer',
+        :'viewed' => :'Integer',
+        :'deferred' => :'Integer',
+        :'return_bounce' => :'Integer'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'listId')
+        self.list_id = attributes[:'listId']
+      end
+
+      if attributes.has_key?(:'uniqueClicks')
+        self.unique_clicks = attributes[:'uniqueClicks']
+      end
+
+      if attributes.has_key?(:'clickers')
+        self.clickers = attributes[:'clickers']
+      end
+
+      if attributes.has_key?(:'complaints')
+        self.complaints = attributes[:'complaints']
+      end
+
+      if attributes.has_key?(:'delivered')
+        self.delivered = attributes[:'delivered']
+      end
+
+      if attributes.has_key?(:'sent')
+        self.sent = attributes[:'sent']
+      end
+
+      if attributes.has_key?(:'softBounces')
+        self.soft_bounces = attributes[:'softBounces']
+      end
+
+      if attributes.has_key?(:'hardBounces')
+        self.hard_bounces = attributes[:'hardBounces']
+      end
+
+      if attributes.has_key?(:'uniqueViews')
+        self.unique_views = attributes[:'uniqueViews']
+      end
+
+      if attributes.has_key?(:'trackableViews')
+        self.trackable_views = attributes[:'trackableViews']
+      end
+
+      if attributes.has_key?(:'trackableViewsRate')
+        self.trackable_views_rate = attributes[:'trackableViewsRate']
+      end
+
+      if attributes.has_key?(:'estimatedViews')
+        self.estimated_views = attributes[:'estimatedViews']
+      end
+
+      if attributes.has_key?(:'unsubscriptions')
+        self.unsubscriptions = attributes[:'unsubscriptions']
+      end
+
+      if attributes.has_key?(:'viewed')
+        self.viewed = attributes[:'viewed']
+      end
+
+      if attributes.has_key?(:'deferred')
+        self.deferred = attributes[:'deferred']
+      end
+
+      if attributes.has_key?(:'returnBounce')
+        self.return_bounce = attributes[:'returnBounce']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @unique_clicks.nil?
+        invalid_properties.push('invalid value for "unique_clicks", unique_clicks cannot be nil.')
+      end
+
+      if @clickers.nil?
+        invalid_properties.push('invalid value for "clickers", clickers cannot be nil.')
+      end
+
+      if @complaints.nil?
+        invalid_properties.push('invalid value for "complaints", complaints cannot be nil.')
+      end
+
+      if @delivered.nil?
+        invalid_properties.push('invalid value for "delivered", delivered cannot be nil.')
+      end
+
+      if @sent.nil?
+        invalid_properties.push('invalid value for "sent", sent cannot be nil.')
+      end
+
+      if @soft_bounces.nil?
+        invalid_properties.push('invalid value for "soft_bounces", soft_bounces cannot be nil.')
+      end
+
+      if @hard_bounces.nil?
+        invalid_properties.push('invalid value for "hard_bounces", hard_bounces cannot be nil.')
+      end
+
+      if @unique_views.nil?
+        invalid_properties.push('invalid value for "unique_views", unique_views cannot be nil.')
+      end
+
+      if @trackable_views.nil?
+        invalid_properties.push('invalid value for "trackable_views", trackable_views cannot be nil.')
+      end
+
+      if @unsubscriptions.nil?
+        invalid_properties.push('invalid value for "unsubscriptions", unsubscriptions cannot be nil.')
+      end
+
+      if @viewed.nil?
+        invalid_properties.push('invalid value for "viewed", viewed cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @unique_clicks.nil?
+      return false if @clickers.nil?
+      return false if @complaints.nil?
+      return false if @delivered.nil?
+      return false if @sent.nil?
+      return false if @soft_bounces.nil?
+      return false if @hard_bounces.nil?
+      return false if @unique_views.nil?
+      return false if @trackable_views.nil?
+      return false if @unsubscriptions.nil?
+      return false if @viewed.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          list_id == o.list_id &&
+          unique_clicks == o.unique_clicks &&
+          clickers == o.clickers &&
+          complaints == o.complaints &&
+          delivered == o.delivered &&
+          sent == o.sent &&
+          soft_bounces == o.soft_bounces &&
+          hard_bounces == o.hard_bounces &&
+          unique_views == o.unique_views &&
+          trackable_views == o.trackable_views &&
+          trackable_views_rate == o.trackable_views_rate &&
+          estimated_views == o.estimated_views &&
+          unsubscriptions == o.unsubscriptions &&
+          viewed == o.viewed &&
+          deferred == o.deferred &&
+          return_bounce == o.return_bounce
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [list_id, unique_clicks, clickers, complaints, delivered, sent, soft_bounces, hard_bounces, unique_views, trackable_views, trackable_views_rate, estimated_views, unsubscriptions, viewed, deferred, return_bounce].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = BrevoRuby.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end