sib-api-v3-sdk 5.2.5 → 5.3.0

data/lib/sib-api-v3-sdk/models/get_device_browser_stats.rb

@@ -0,0 +1,234 @@
+=begin
+#SendinBlue API
+
+#SendinBlue 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/sendinblue  **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@sendinblue.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.12
+
+=end
+
+require 'date'
+
+module SibApiV3Sdk
+  class GetDeviceBrowserStats
+    # Number of total clicks for the campaign using the particular browser
+    attr_accessor :clickers
+
+    # Number of unique clicks for the campaign using the particular browser
+    attr_accessor :unique_clicks
+
+    # Number of openings for the campaign using the particular browser
+    attr_accessor :viewed
+
+    # Number of unique openings for the campaign using the particular browser
+    attr_accessor :unique_views
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'clickers' => :'clickers',
+        :'unique_clicks' => :'uniqueClicks',
+        :'viewed' => :'viewed',
+        :'unique_views' => :'uniqueViews'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'clickers' => :'Integer',
+        :'unique_clicks' => :'Integer',
+        :'viewed' => :'Integer',
+        :'unique_views' => :'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?(:'clickers')
+        self.clickers = attributes[:'clickers']
+      end
+
+      if attributes.has_key?(:'uniqueClicks')
+        self.unique_clicks = attributes[:'uniqueClicks']
+      end
+
+      if attributes.has_key?(:'viewed')
+        self.viewed = attributes[:'viewed']
+      end
+
+      if attributes.has_key?(:'uniqueViews')
+        self.unique_views = attributes[:'uniqueViews']
+      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 @clickers.nil?
+        invalid_properties.push('invalid value for "clickers", clickers cannot be nil.')
+      end
+
+      if @unique_clicks.nil?
+        invalid_properties.push('invalid value for "unique_clicks", unique_clicks cannot be nil.')
+      end
+
+      if @viewed.nil?
+        invalid_properties.push('invalid value for "viewed", viewed cannot be nil.')
+      end
+
+      if @unique_views.nil?
+        invalid_properties.push('invalid value for "unique_views", unique_views 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 @clickers.nil?
+      return false if @unique_clicks.nil?
+      return false if @viewed.nil?
+      return false if @unique_views.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 &&
+          clickers == o.clickers &&
+          unique_clicks == o.unique_clicks &&
+          viewed == o.viewed &&
+          unique_views == o.unique_views
+    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
+      [clickers, unique_clicks, viewed, unique_views].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 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 = SibApiV3Sdk.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/sib-api-v3-sdk/models/get_email_campaign.rb

@@ -1,19 +1,18 @@
 =begin
 #SendinBlue API
 
-#SendinBlue 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/sendinblue  **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  | 
+#SendinBlue 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/sendinblue  **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@sendinblue.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Swagger Codegen version: 2.4.12
 
 =end
 
 require 'date'
 
 module SibApiV3Sdk
-
   class GetEmailCampaign
     # ID of the campaign
     attr_accessor :id
@@ -202,7 +201,7 @@ module SibApiV3Sdk
       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}
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
       if attributes.has_key?(:'id')
         self.id = attributes[:'id']
@@ -323,7 +322,6 @@ module SibApiV3Sdk
       if attributes.has_key?(:'statistics')
         self.statistics = attributes[:'statistics']
       end
-
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -331,70 +329,70 @@ module SibApiV3Sdk
     def list_invalid_properties
       invalid_properties = Array.new
       if @id.nil?
-        invalid_properties.push("invalid value for 'id', id cannot be nil.")
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
       if @name.nil?
-        invalid_properties.push("invalid value for 'name', name cannot be nil.")
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
       end
 
       if @type.nil?
-        invalid_properties.push("invalid value for 'type', type cannot be nil.")
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
 
       if @status.nil?
-        invalid_properties.push("invalid value for 'status', status cannot be nil.")
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
       end
 
       if @test_sent.nil?
-        invalid_properties.push("invalid value for 'test_sent', test_sent cannot be nil.")
+        invalid_properties.push('invalid value for "test_sent", test_sent cannot be nil.')
       end
 
       if @header.nil?
-        invalid_properties.push("invalid value for 'header', header cannot be nil.")
+        invalid_properties.push('invalid value for "header", header cannot be nil.')
       end
 
       if @footer.nil?
-        invalid_properties.push("invalid value for 'footer', footer cannot be nil.")
+        invalid_properties.push('invalid value for "footer", footer cannot be nil.')
       end
 
       if @sender.nil?
-        invalid_properties.push("invalid value for 'sender', sender cannot be nil.")
+        invalid_properties.push('invalid value for "sender", sender cannot be nil.')
       end
 
       if @reply_to.nil?
-        invalid_properties.push("invalid value for 'reply_to', reply_to cannot be nil.")
+        invalid_properties.push('invalid value for "reply_to", reply_to cannot be nil.')
       end
 
       if @to_field.nil?
-        invalid_properties.push("invalid value for 'to_field', to_field cannot be nil.")
+        invalid_properties.push('invalid value for "to_field", to_field cannot be nil.')
       end
 
       if @html_content.nil?
-        invalid_properties.push("invalid value for 'html_content', html_content cannot be nil.")
+        invalid_properties.push('invalid value for "html_content", html_content cannot be nil.')
       end
 
       if @tag.nil?
-        invalid_properties.push("invalid value for 'tag', tag cannot be nil.")
+        invalid_properties.push('invalid value for "tag", tag cannot be nil.')
       end
 
       if @created_at.nil?
-        invalid_properties.push("invalid value for 'created_at', created_at cannot be nil.")
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
 
       if @modified_at.nil?
-        invalid_properties.push("invalid value for 'modified_at', modified_at cannot be nil.")
+        invalid_properties.push('invalid value for "modified_at", modified_at cannot be nil.')
       end
 
       if @recipients.nil?
-        invalid_properties.push("invalid value for 'recipients', recipients cannot be nil.")
+        invalid_properties.push('invalid value for "recipients", recipients cannot be nil.')
       end
 
       if @statistics.nil?
-        invalid_properties.push("invalid value for 'statistics', statistics cannot be nil.")
+        invalid_properties.push('invalid value for "statistics", statistics cannot be nil.')
       end
 
-      return invalid_properties
+      invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
@@ -403,10 +401,10 @@ module SibApiV3Sdk
       return false if @id.nil?
       return false if @name.nil?
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["classic", "trigger"])
+      type_validator = EnumAttributeValidator.new('String', ['classic', 'trigger'])
       return false unless type_validator.valid?(@type)
       return false if @status.nil?
-      status_validator = EnumAttributeValidator.new('String', ["draft", "sent", "archive", "queued", "suspended", "in_process"])
+      status_validator = EnumAttributeValidator.new('String', ['draft', 'sent', 'archive', 'queued', 'suspended', 'in_process'])
       return false unless status_validator.valid?(@status)
       return false if @test_sent.nil?
       return false if @header.nil?
@@ -420,15 +418,15 @@ module SibApiV3Sdk
       return false if @modified_at.nil?
       return false if @recipients.nil?
       return false if @statistics.nil?
-      return true
+      true
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["classic", "trigger"])
+      validator = EnumAttributeValidator.new('String', ['classic', 'trigger'])
       unless validator.valid?(type)
-        fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
+        fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
       end
       @type = type
     end
@@ -436,9 +434,9 @@ module SibApiV3Sdk
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
-      validator = EnumAttributeValidator.new('String', ["draft", "sent", "archive", "queued", "suspended", "in_process"])
+      validator = EnumAttributeValidator.new('String', ['draft', 'sent', 'archive', 'queued', 'suspended', 'in_process'])
       unless validator.valid?(status)
-        fail ArgumentError, "invalid value for 'status', must be one of #{validator.allowable_values}."
+        fail ArgumentError, 'invalid value for "status", must be one of #{validator.allowable_values}.'
       end
       @status = status
     end
@@ -502,7 +500,7 @@ module SibApiV3Sdk
           # check to ensure the input is an array given that the 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) } )
+            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]]))
@@ -584,7 +582,7 @@ module SibApiV3Sdk
     # @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) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -595,7 +593,5 @@ module SibApiV3Sdk
         value
       end
     end
-
   end
-
 end

data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb

@@ -1,26 +1,24 @@
 =begin
 #SendinBlue API
 
-#SendinBlue 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/sendinblue  **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  | 
+#SendinBlue 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/sendinblue  **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@sendinblue.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Swagger Codegen version: 2.4.12
 
 =end
 
 require 'date'
 
 module SibApiV3Sdk
-
   class GetEmailCampaigns
     attr_accessor :campaigns
 
     # Number of Email campaigns retrieved
     attr_accessor :count
 
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -43,7 +41,7 @@ module SibApiV3Sdk
       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}
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
       if attributes.has_key?(:'campaigns')
         if (value = attributes[:'campaigns']).is_a?(Array)
@@ -54,7 +52,6 @@ module SibApiV3Sdk
       if attributes.has_key?(:'count')
         self.count = attributes[:'count']
       end
-
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -62,17 +59,17 @@ module SibApiV3Sdk
     def list_invalid_properties
       invalid_properties = Array.new
       if @count.nil?
-        invalid_properties.push("invalid value for 'count', count cannot be nil.")
+        invalid_properties.push('invalid value for "count", count cannot be nil.')
       end
 
-      return invalid_properties
+      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 @count.nil?
-      return true
+      true
     end
 
     # Checks equality by comparing each attribute.
@@ -106,7 +103,7 @@ module SibApiV3Sdk
           # check to ensure the input is an array given that the 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) } )
+            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]]))
@@ -188,7 +185,7 @@ module SibApiV3Sdk
     # @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) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -199,7 +196,5 @@ module SibApiV3Sdk
         value
       end
     end
-
   end
-
 end