sib-api-v3-sdk 7.5.0 → 8.0.0

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

@@ -0,0 +1,278 @@
+=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.19
+
+=end
+
+require 'date'
+
+module SibApiV3Sdk
+  # File data that is uploaded
+  class FileData
+    # Url of uploaded file
+    attr_accessor :url
+
+    # Id of uploaded file
+    attr_accessor :id
+
+    # Name of uploaded file
+    attr_accessor :name
+
+    # Account id of user which created the file
+    attr_accessor :author_id
+
+    # Account details of user which created the file
+    attr_accessor :author
+
+    # Contact id of contact on which file is uploaded
+    attr_accessor :contact_id
+
+    # Deal ids linked to a file
+    attr_accessor :deal_ids
+
+    # Size of file uploaded
+    attr_accessor :size
+
+    # File created date/time
+    attr_accessor :created_at
+
+    # File updated date/time
+    attr_accessor :updated_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'url' => :'url',
+        :'id' => :'id',
+        :'name' => :'name',
+        :'author_id' => :'authorId',
+        :'author' => :'author',
+        :'contact_id' => :'contactId',
+        :'deal_ids' => :'dealIds',
+        :'size' => :'size',
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'url' => :'String',
+        :'id' => :'String',
+        :'name' => :'String',
+        :'author_id' => :'String',
+        :'author' => :'Object',
+        :'contact_id' => :'Integer',
+        :'deal_ids' => :'Array<String>',
+        :'size' => :'Integer',
+        :'created_at' => :'DateTime',
+        :'updated_at' => :'DateTime'
+      }
+    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?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'authorId')
+        self.author_id = attributes[:'authorId']
+      end
+
+      if attributes.has_key?(:'author')
+        self.author = attributes[:'author']
+      end
+
+      if attributes.has_key?(:'contactId')
+        self.contact_id = attributes[:'contactId']
+      end
+
+      if attributes.has_key?(:'dealIds')
+        if (value = attributes[:'dealIds']).is_a?(Array)
+          self.deal_ids = value
+        end
+      end
+
+      if attributes.has_key?(:'size')
+        self.size = attributes[:'size']
+      end
+
+      if attributes.has_key?(:'createdAt')
+        self.created_at = attributes[:'createdAt']
+      end
+
+      if attributes.has_key?(:'updatedAt')
+        self.updated_at = attributes[:'updatedAt']
+      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
+      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?
+      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 &&
+          url == o.url &&
+          id == o.id &&
+          name == o.name &&
+          author_id == o.author_id &&
+          author == o.author &&
+          contact_id == o.contact_id &&
+          deal_ids == o.deal_ids &&
+          size == o.size &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
+    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
+      [url, id, name, author_id, author, contact_id, deal_ids, size, created_at, updated_at].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 = 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_campaign_stats.rb

@@ -41,6 +41,9 @@ module SibApiV3Sdk
     # 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
+
     # Number of unsubscription for the campaign
     attr_accessor :unsubscriptions
 
@@ -65,6 +68,7 @@ module SibApiV3Sdk
         :'soft_bounces' => :'softBounces',
         :'hard_bounces' => :'hardBounces',
         :'unique_views' => :'uniqueViews',
+        :'trackable_views' => :'trackableViews',
         :'unsubscriptions' => :'unsubscriptions',
         :'viewed' => :'viewed',
         :'deferred' => :'deferred',
@@ -84,6 +88,7 @@ module SibApiV3Sdk
         :'soft_bounces' => :'Integer',
         :'hard_bounces' => :'Integer',
         :'unique_views' => :'Integer',
+        :'trackable_views' => :'Integer',
         :'unsubscriptions' => :'Integer',
         :'viewed' => :'Integer',
         :'deferred' => :'Integer',
@@ -135,6 +140,10 @@ module SibApiV3Sdk
         self.unique_views = attributes[:'uniqueViews']
       end
 
+      if attributes.has_key?(:'trackableViews')
+        self.trackable_views = attributes[:'trackableViews']
+      end
+
       if attributes.has_key?(:'unsubscriptions')
         self.unsubscriptions = attributes[:'unsubscriptions']
       end
@@ -188,6 +197,10 @@ module SibApiV3Sdk
         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
@@ -210,6 +223,7 @@ module SibApiV3Sdk
       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
@@ -229,6 +243,7 @@ module SibApiV3Sdk
           soft_bounces == o.soft_bounces &&
           hard_bounces == o.hard_bounces &&
           unique_views == o.unique_views &&
+          trackable_views == o.trackable_views &&
           unsubscriptions == o.unsubscriptions &&
           viewed == o.viewed &&
           deferred == o.deferred &&
@@ -244,7 +259,7 @@ module SibApiV3Sdk
     # 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, unsubscriptions, viewed, deferred, return_bounce].hash
+      [list_id, unique_clicks, clickers, complaints, delivered, sent, soft_bounces, hard_bounces, unique_views, trackable_views, unsubscriptions, viewed, deferred, return_bounce].hash
     end
 
     # Builds the object from hash

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

@@ -31,6 +31,8 @@ module SibApiV3Sdk
 
     attr_accessor :transac_attributes
 
+    attr_accessor :delivered
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -41,7 +43,8 @@ module SibApiV3Sdk
         :'unsubscriptions' => :'unsubscriptions',
         :'opened' => :'opened',
         :'clicked' => :'clicked',
-        :'transac_attributes' => :'transacAttributes'
+        :'transac_attributes' => :'transacAttributes',
+        :'delivered' => :'delivered'
       }
     end
 
@@ -55,7 +58,8 @@ module SibApiV3Sdk
         :'unsubscriptions' => :'GetContactCampaignStatsUnsubscriptions',
         :'opened' => :'Array<GetContactCampaignStatsOpened>',
         :'clicked' => :'Array<GetContactCampaignStatsClicked>',
-        :'transac_attributes' => :'Array<GetContactCampaignStatsTransacAttributes>'
+        :'transac_attributes' => :'Array<GetContactCampaignStatsTransacAttributes>',
+        :'delivered' => :'Array<GetExtendedContactDetailsStatisticsMessagesSent>'
       }
     end
 
@@ -112,6 +116,12 @@ module SibApiV3Sdk
           self.transac_attributes = value
         end
       end
+
+      if attributes.has_key?(:'delivered')
+        if (value = attributes[:'delivered']).is_a?(Array)
+          self.delivered = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -139,7 +149,8 @@ module SibApiV3Sdk
           unsubscriptions == o.unsubscriptions &&
           opened == o.opened &&
           clicked == o.clicked &&
-          transac_attributes == o.transac_attributes
+          transac_attributes == o.transac_attributes &&
+          delivered == o.delivered
     end
 
     # @see the `==` method
@@ -151,7 +162,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [messages_sent, hard_bounces, soft_bounces, complaints, unsubscriptions, opened, clicked, transac_attributes].hash
+      [messages_sent, hard_bounces, soft_bounces, complaints, unsubscriptions, opened, clicked, transac_attributes, delivered].hash
     end
 
     # Builds the object from hash

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

@@ -38,6 +38,9 @@ module SibApiV3Sdk
     # Listing of the transactional attributes for the contact
     attr_accessor :transac_attributes
 
+    # Listing of the delivered campaign for the contact
+    attr_accessor :delivered
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -48,7 +51,8 @@ module SibApiV3Sdk
         :'unsubscriptions' => :'unsubscriptions',
         :'opened' => :'opened',
         :'clicked' => :'clicked',
-        :'transac_attributes' => :'transacAttributes'
+        :'transac_attributes' => :'transacAttributes',
+        :'delivered' => :'delivered'
       }
     end
 
@@ -62,7 +66,8 @@ module SibApiV3Sdk
         :'unsubscriptions' => :'GetExtendedContactDetailsStatisticsUnsubscriptions',
         :'opened' => :'Array<GetExtendedContactDetailsStatisticsOpened>',
         :'clicked' => :'Array<GetExtendedContactDetailsStatisticsClicked>',
-        :'transac_attributes' => :'Array<Object>'
+        :'transac_attributes' => :'Array<Object>',
+        :'delivered' => :'Array<GetExtendedContactDetailsStatisticsDelivered>'
       }
     end
 
@@ -119,6 +124,12 @@ module SibApiV3Sdk
           self.transac_attributes = value
         end
       end
+
+      if attributes.has_key?(:'delivered')
+        if (value = attributes[:'delivered']).is_a?(Array)
+          self.delivered = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -146,7 +157,8 @@ module SibApiV3Sdk
           unsubscriptions == o.unsubscriptions &&
           opened == o.opened &&
           clicked == o.clicked &&
-          transac_attributes == o.transac_attributes
+          transac_attributes == o.transac_attributes &&
+          delivered == o.delivered
     end
 
     # @see the `==` method
@@ -158,7 +170,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [messages_sent, hard_bounces, soft_bounces, complaints, unsubscriptions, opened, clicked, transac_attributes].hash
+      [messages_sent, hard_bounces, soft_bounces, complaints, unsubscriptions, opened, clicked, transac_attributes, delivered].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,205 @@
+=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.19
+
+=end
+
+require 'date'
+
+module SibApiV3Sdk
+  class GetExtendedContactDetailsStatisticsDelivered
+    # ID of the campaign which generated the event
+    attr_accessor :campaign_id
+
+    # UTC date-time 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 properties 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
+
+      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?
+      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 &&
+          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 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