sib-api-v3-sdk 8.1.0 → 9.1.0

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

@@ -44,6 +44,12 @@ module SibApiV3Sdk
     # 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
 
@@ -69,6 +75,8 @@ module SibApiV3Sdk
         :'hard_bounces' => :'hardBounces',
         :'unique_views' => :'uniqueViews',
         :'trackable_views' => :'trackableViews',
+        :'trackable_views_rate' => :'trackableViewsRate',
+        :'estimated_views' => :'estimatedViews',
         :'unsubscriptions' => :'unsubscriptions',
         :'viewed' => :'viewed',
         :'deferred' => :'deferred',
@@ -89,6 +97,8 @@ module SibApiV3Sdk
         :'hard_bounces' => :'Integer',
         :'unique_views' => :'Integer',
         :'trackable_views' => :'Integer',
+        :'trackable_views_rate' => :'Float',
+        :'estimated_views' => :'Integer',
         :'unsubscriptions' => :'Integer',
         :'viewed' => :'Integer',
         :'deferred' => :'Integer',
@@ -144,6 +154,14 @@ module SibApiV3Sdk
         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
@@ -244,6 +262,8 @@ module SibApiV3Sdk
           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 &&
@@ -259,7 +279,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, trackable_views, unsubscriptions, viewed, deferred, return_bounce].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

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

@@ -0,0 +1,196 @@
+=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 GetScheduledEmailByBatchId
+    # Total number of batches
+    attr_accessor :count
+
+    attr_accessor :batches
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'count' => :'count',
+        :'batches' => :'batches'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'count' => :'Integer',
+        :'batches' => :'Array<GetScheduledEmailByBatchIdBatches>'
+      }
+    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?(:'count')
+        self.count = attributes[:'count']
+      end
+
+      if attributes.has_key?(:'batches')
+        if (value = attributes[:'batches']).is_a?(Array)
+          self.batches = 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
+      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 &&
+          count == o.count &&
+          batches == o.batches
+    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
+      [count, batches].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/{contact.rb → get_scheduled_email_by_batch_id_batches.rb}

@@ -13,57 +13,53 @@ Swagger Codegen version: 2.4.19
 require 'date'
 
 module SibApiV3Sdk
-  # Contact Details
-  class Contact
-    # Next incomplete task of contact
-    attr_accessor :virtual_next_task
+  class GetScheduledEmailByBatchIdBatches
+    # Datetime for which the batch was scheduled
+    attr_accessor :scheduled_at
 
-    # Contact email
-    attr_accessor :email
-
-    # User id to whom contact is assigned
-    attr_accessor :assign_to_id
-
-    # Contact id
-    attr_accessor :contacts_id
-
-    # CRM lists in which contact is added
-    attr_accessor :crm_lists
-
-    # Contact attributes e.g firstname / lastname / SMS etc.
-    attr_accessor :attributes
-
-    # Contact created date/time
+    # Datetime on which the batch was scheduled
     attr_accessor :created_at
 
-    # Contact updated date/time
-    attr_accessor :updated_at
+    # Current status of the scheduled batch
+    attr_accessor :status
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'virtual_next_task' => :'virtualNextTask',
-        :'email' => :'email',
-        :'assign_to_id' => :'assignToId',
-        :'contacts_id' => :'contactsId',
-        :'crm_lists' => :'crmLists',
-        :'attributes' => :'attributes',
+        :'scheduled_at' => :'scheduledAt',
         :'created_at' => :'createdAt',
-        :'updated_at' => :'updatedAt'
+        :'status' => :'status'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'virtual_next_task' => :'Object',
-        :'email' => :'String',
-        :'assign_to_id' => :'String',
-        :'contacts_id' => :'Integer',
-        :'crm_lists' => :'Object',
-        :'attributes' => :'Object',
+        :'scheduled_at' => :'DateTime',
         :'created_at' => :'DateTime',
-        :'updated_at' => :'DateTime'
+        :'status' => :'String'
       }
     end
 
@@ -75,36 +71,16 @@ module SibApiV3Sdk
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.has_key?(:'virtualNextTask')
-        self.virtual_next_task = attributes[:'virtualNextTask']
-      end
-
-      if attributes.has_key?(:'email')
-        self.email = attributes[:'email']
-      end
-
-      if attributes.has_key?(:'assignToId')
-        self.assign_to_id = attributes[:'assignToId']
-      end
-
-      if attributes.has_key?(:'contactsId')
-        self.contacts_id = attributes[:'contactsId']
-      end
-
-      if attributes.has_key?(:'crmLists')
-        self.crm_lists = attributes[:'crmLists']
-      end
-
-      if attributes.has_key?(:'attributes')
-        self.attributes = attributes[:'attributes']
+      if attributes.has_key?(:'scheduledAt')
+        self.scheduled_at = attributes[:'scheduledAt']
       end
 
       if attributes.has_key?(:'createdAt')
         self.created_at = attributes[:'createdAt']
       end
 
-      if attributes.has_key?(:'updatedAt')
-        self.updated_at = attributes[:'updatedAt']
+      if attributes.has_key?(:'status')
+        self.status = attributes[:'status']
       end
     end
 
@@ -112,12 +88,16 @@ module SibApiV3Sdk
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @email.nil?
-        invalid_properties.push('invalid value for "email", email cannot be nil.')
+      if @scheduled_at.nil?
+        invalid_properties.push('invalid value for "scheduled_at", scheduled_at cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
 
-      if @crm_lists.nil?
-        invalid_properties.push('invalid value for "crm_lists", crm_lists cannot be nil.')
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
       end
 
       invalid_properties
@@ -126,24 +106,32 @@ module SibApiV3Sdk
     # 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 @email.nil?
-      return false if @crm_lists.nil?
+      return false if @scheduled_at.nil?
+      return false if @created_at.nil?
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ['inProgress', 'queued', 'processed', 'error'])
+      return false unless status_validator.valid?(@status)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ['inProgress', 'queued', 'processed', 'error'])
+      unless validator.valid?(status)
+        fail ArgumentError, 'invalid value for "status", must be one of #{validator.allowable_values}.'
+      end
+      @status = status
+    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 &&
-          virtual_next_task == o.virtual_next_task &&
-          email == o.email &&
-          assign_to_id == o.assign_to_id &&
-          contacts_id == o.contacts_id &&
-          crm_lists == o.crm_lists &&
-          attributes == o.attributes &&
+          scheduled_at == o.scheduled_at &&
           created_at == o.created_at &&
-          updated_at == o.updated_at
+          status == o.status
     end
 
     # @see the `==` method
@@ -155,7 +143,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [virtual_next_task, email, assign_to_id, contacts_id, crm_lists, attributes, created_at, updated_at].hash
+      [scheduled_at, created_at, status].hash
     end
 
     # Builds the object from hash