sib-api-v3-sdk 2.0.0 → 2.0.1

data/lib/sib-api-v3-sdk/models/{get_contact_campaign_stats_messages_sent.rb → get_extended_contact_details_statistics_clicked.rb}

@@ -14,19 +14,19 @@ require 'date'
 
 module SibApiV3Sdk
 
-  class GetContactCampaignStatsMessagesSent
+  class GetExtendedContactDetailsStatisticsClicked
     # ID of the campaign which generated the event
     attr_accessor :campaign_id
 
-    # Date of the event
-    attr_accessor :event_time
+    # Listing of the clicked links for the campaign
+    attr_accessor :links
 
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'campaign_id' => :'campaignId',
-        :'event_time' => :'eventTime'
+        :'links' => :'links'
       }
     end
 
@@ -34,7 +34,7 @@ module SibApiV3Sdk
     def self.swagger_types
       {
         :'campaign_id' => :'Integer',
-        :'event_time' => :'DateTime'
+        :'links' => :'Array<GetExtendedContactDetailsStatisticsLinks>'
       }
     end
 
@@ -50,8 +50,10 @@ module SibApiV3Sdk
         self.campaign_id = attributes[:'campaignId']
       end
 
-      if attributes.has_key?(:'eventTime')
-        self.event_time = attributes[:'eventTime']
+      if attributes.has_key?(:'links')
+        if (value = attributes[:'links']).is_a?(Array)
+          self.links = value
+        end
       end
 
     end
@@ -64,8 +66,8 @@ module SibApiV3Sdk
         invalid_properties.push("invalid value for 'campaign_id', campaign_id cannot be nil.")
       end
 
-      if @event_time.nil?
-        invalid_properties.push("invalid value for 'event_time', event_time cannot be nil.")
+      if @links.nil?
+        invalid_properties.push("invalid value for 'links', links cannot be nil.")
       end
 
       return invalid_properties
@@ -75,7 +77,7 @@ module SibApiV3Sdk
     # @return true if the model is valid
     def valid?
       return false if @campaign_id.nil?
-      return false if @event_time.nil?
+      return false if @links.nil?
       return true
     end
 
@@ -85,7 +87,7 @@ module SibApiV3Sdk
       return true if self.equal?(o)
       self.class == o.class &&
           campaign_id == o.campaign_id &&
-          event_time == o.event_time
+          links == o.links
     end
 
     # @see the `==` method
@@ -97,7 +99,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [campaign_id, event_time].hash
+      [campaign_id, links].hash
     end
 
     # Builds the object from hash

data/lib/sib-api-v3-sdk/models/{get_contact_campaign_stats_links.rb → get_extended_contact_details_statistics_links.rb}

@@ -14,7 +14,7 @@ require 'date'
 
 module SibApiV3Sdk
 
-  class GetContactCampaignStatsLinks
+  class GetExtendedContactDetailsStatisticsLinks
     # Number of clicks on this link for the campaign
     attr_accessor :count
 
@@ -42,7 +42,7 @@ module SibApiV3Sdk
     def self.swagger_types
       {
         :'count' => :'Integer',
-        :'event_time' => :'DateTime',
+        :'event_time' => :'String',
         :'ip' => :'String',
         :'url' => :'String'
       }
@@ -86,6 +86,10 @@ module SibApiV3Sdk
         invalid_properties.push("invalid value for 'event_time', event_time cannot be nil.")
       end
 
+      if @event_time !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
+        invalid_properties.push("invalid value for 'event_time', must conform to the pattern /^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/.")
+      end
+
       if @ip.nil?
         invalid_properties.push("invalid value for 'ip', ip cannot be nil.")
       end
@@ -102,11 +106,26 @@ module SibApiV3Sdk
     def valid?
       return false if @count.nil?
       return false if @event_time.nil?
+      return false if @event_time !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
       return false if @ip.nil?
       return false if @url.nil?
       return true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] event_time Value to be assigned
+    def event_time=(event_time)
+      if event_time.nil?
+        fail ArgumentError, "event_time cannot be nil"
+      end
+
+      if event_time !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
+        fail ArgumentError, "invalid value for 'event_time', must conform to the pattern /^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/."
+      end
+
+      @event_time = event_time
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

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

@@ -0,0 +1,228 @@
+=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  | 
+
+OpenAPI spec version: 3.0.0
+Contact: contact@sendinblue.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
+
+=end
+
+require 'date'
+
+module SibApiV3Sdk
+
+  class GetExtendedContactDetailsStatisticsMessagesSent
+    # ID of the campaign which generated the event
+    attr_accessor :campaign_id
+
+    # Date of the event
+    attr_accessor :event_time
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'campaign_id' => :'campaignId',
+        :'event_time' => :'eventTime'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'campaign_id' => :'Integer',
+        :'event_time' => :'String'
+      }
+    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?(:'campaignId')
+        self.campaign_id = attributes[:'campaignId']
+      end
+
+      if attributes.has_key?(:'eventTime')
+        self.event_time = attributes[:'eventTime']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @campaign_id.nil?
+        invalid_properties.push("invalid value for 'campaign_id', campaign_id cannot be nil.")
+      end
+
+      if @event_time.nil?
+        invalid_properties.push("invalid value for 'event_time', event_time cannot be nil.")
+      end
+
+      if @event_time !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
+        invalid_properties.push("invalid value for 'event_time', must conform to the pattern /^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/.")
+      end
+
+      return 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 @campaign_id.nil?
+      return false if @event_time.nil?
+      return false if @event_time !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
+      return true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] event_time Value to be assigned
+    def event_time=(event_time)
+      if event_time.nil?
+        fail ArgumentError, "event_time cannot be nil"
+      end
+
+      if event_time !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
+        fail ArgumentError, "invalid value for 'event_time', must conform to the pattern /^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/."
+      end
+
+      @event_time = event_time
+    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 &&
+          campaign_id == o.campaign_id &&
+          event_time == o.event_time
+    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
+      [campaign_id, event_time].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_extended_contact_details_statistics_opened.rb

@@ -0,0 +1,258 @@
+=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  | 
+
+OpenAPI spec version: 3.0.0
+Contact: contact@sendinblue.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
+
+=end
+
+require 'date'
+
+module SibApiV3Sdk
+
+  class GetExtendedContactDetailsStatisticsOpened
+    # ID of the campaign which generated the event
+    attr_accessor :campaign_id
+
+    # Number of openings for the campaign
+    attr_accessor :count
+
+    # Date of the event
+    attr_accessor :event_time
+
+    # IP from which the user has opened the email
+    attr_accessor :ip
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'campaign_id' => :'campaignId',
+        :'count' => :'count',
+        :'event_time' => :'eventTime',
+        :'ip' => :'ip'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'campaign_id' => :'Integer',
+        :'count' => :'Integer',
+        :'event_time' => :'String',
+        :'ip' => :'String'
+      }
+    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?(:'campaignId')
+        self.campaign_id = attributes[:'campaignId']
+      end
+
+      if attributes.has_key?(:'count')
+        self.count = attributes[:'count']
+      end
+
+      if attributes.has_key?(:'eventTime')
+        self.event_time = attributes[:'eventTime']
+      end
+
+      if attributes.has_key?(:'ip')
+        self.ip = attributes[:'ip']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @campaign_id.nil?
+        invalid_properties.push("invalid value for 'campaign_id', campaign_id cannot be nil.")
+      end
+
+      if @count.nil?
+        invalid_properties.push("invalid value for 'count', count cannot be nil.")
+      end
+
+      if @event_time.nil?
+        invalid_properties.push("invalid value for 'event_time', event_time cannot be nil.")
+      end
+
+      if @event_time !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
+        invalid_properties.push("invalid value for 'event_time', must conform to the pattern /^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/.")
+      end
+
+      if @ip.nil?
+        invalid_properties.push("invalid value for 'ip', ip cannot be nil.")
+      end
+
+      return 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 @campaign_id.nil?
+      return false if @count.nil?
+      return false if @event_time.nil?
+      return false if @event_time !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
+      return false if @ip.nil?
+      return true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] event_time Value to be assigned
+    def event_time=(event_time)
+      if event_time.nil?
+        fail ArgumentError, "event_time cannot be nil"
+      end
+
+      if event_time !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
+        fail ArgumentError, "invalid value for 'event_time', must conform to the pattern /^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/."
+      end
+
+      @event_time = event_time
+    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 &&
+          campaign_id == o.campaign_id &&
+          count == o.count &&
+          event_time == o.event_time &&
+          ip == o.ip
+    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
+      [campaign_id, count, event_time, ip].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