sib-api-v3-sdk 5.2.5 → 5.3.0

data/lib/sib-api-v3-sdk/models/create_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 CreateEmailCampaign
     # Tag of the campaign
     attr_accessor :tag
@@ -88,6 +87,15 @@ module SibApiV3Sdk
     # Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed
     attr_accessor :winner_delay
 
+    # Available for dedicated ip clients. Set this to true if you wish to warm up your ip.
+    attr_accessor :ip_warmup_enable
+
+    # Mandatory if ipWarmupEnable is set to true. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000.
+    attr_accessor :initial_quota
+
+    # Mandatory if ipWarmupEnable is set to true. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%.
+    attr_accessor :increase_rate
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -137,7 +145,10 @@ module SibApiV3Sdk
         :'subject_b' => :'subjectB',
         :'split_rule' => :'splitRule',
         :'winner_criteria' => :'winnerCriteria',
-        :'winner_delay' => :'winnerDelay'
+        :'winner_delay' => :'winnerDelay',
+        :'ip_warmup_enable' => :'ipWarmupEnable',
+        :'initial_quota' => :'initialQuota',
+        :'increase_rate' => :'increaseRate'
       }
     end
 
@@ -168,7 +179,10 @@ module SibApiV3Sdk
         :'subject_b' => :'String',
         :'split_rule' => :'Integer',
         :'winner_criteria' => :'String',
-        :'winner_delay' => :'Integer'
+        :'winner_delay' => :'Integer',
+        :'ip_warmup_enable' => :'BOOLEAN',
+        :'initial_quota' => :'Integer',
+        :'increase_rate' => :'Integer'
       }
     end
 
@@ -178,7 +192,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?(:'tag')
         self.tag = attributes[:'tag']
@@ -286,6 +300,19 @@ module SibApiV3Sdk
         self.winner_delay = attributes[:'winnerDelay']
       end
 
+      if attributes.has_key?(:'ipWarmupEnable')
+        self.ip_warmup_enable = attributes[:'ipWarmupEnable']
+      else
+        self.ip_warmup_enable = false
+      end
+
+      if attributes.has_key?(:'initialQuota')
+        self.initial_quota = attributes[:'initialQuota']
+      end
+
+      if attributes.has_key?(:'increaseRate')
+        self.increase_rate = attributes[:'increaseRate']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -293,30 +320,38 @@ module SibApiV3Sdk
     def list_invalid_properties
       invalid_properties = Array.new
       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 @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 !@split_rule.nil? && @split_rule > 50
-        invalid_properties.push("invalid value for 'split_rule', must be smaller than or equal to 50.")
+        invalid_properties.push('invalid value for "split_rule", must be smaller than or equal to 50.')
       end
 
       if !@split_rule.nil? && @split_rule < 1
-        invalid_properties.push("invalid value for 'split_rule', must be greater than or equal to 1.")
+        invalid_properties.push('invalid value for "split_rule", must be greater than or equal to 1.')
       end
 
       if !@winner_delay.nil? && @winner_delay > 168
-        invalid_properties.push("invalid value for 'winner_delay', must be smaller than or equal to 168.")
+        invalid_properties.push('invalid value for "winner_delay", must be smaller than or equal to 168.')
       end
 
       if !@winner_delay.nil? && @winner_delay < 1
-        invalid_properties.push("invalid value for 'winner_delay', must be greater than or equal to 1.")
+        invalid_properties.push('invalid value for "winner_delay", must be greater than or equal to 1.')
       end
 
-      return invalid_properties
+      if !@increase_rate.nil? && @increase_rate > 100
+        invalid_properties.push('invalid value for "increase_rate", must be smaller than or equal to 100.')
+      end
+
+      if !@increase_rate.nil? && @increase_rate < 0
+        invalid_properties.push('invalid value for "increase_rate", must be greater than or equal to 0.')
+      end
+
+      invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
@@ -326,23 +361,24 @@ module SibApiV3Sdk
       return false if @name.nil?
       return false if !@split_rule.nil? && @split_rule > 50
       return false if !@split_rule.nil? && @split_rule < 1
-      winner_criteria_validator = EnumAttributeValidator.new('String', ["open", "click"])
+      winner_criteria_validator = EnumAttributeValidator.new('String', ['open', 'click'])
       return false unless winner_criteria_validator.valid?(@winner_criteria)
       return false if !@winner_delay.nil? && @winner_delay > 168
       return false if !@winner_delay.nil? && @winner_delay < 1
-      return true
+      return false if !@increase_rate.nil? && @increase_rate > 100
+      return false if !@increase_rate.nil? && @increase_rate < 0
+      true
     end
 
     # Custom attribute writer method with validation
     # @param [Object] split_rule Value to be assigned
     def split_rule=(split_rule)
-
       if !split_rule.nil? && split_rule > 50
-        fail ArgumentError, "invalid value for 'split_rule', must be smaller than or equal to 50."
+        fail ArgumentError, 'invalid value for "split_rule", must be smaller than or equal to 50.'
       end
 
       if !split_rule.nil? && split_rule < 1
-        fail ArgumentError, "invalid value for 'split_rule', must be greater than or equal to 1."
+        fail ArgumentError, 'invalid value for "split_rule", must be greater than or equal to 1.'
       end
 
       @split_rule = split_rule
@@ -351,9 +387,9 @@ module SibApiV3Sdk
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] winner_criteria Object to be assigned
     def winner_criteria=(winner_criteria)
-      validator = EnumAttributeValidator.new('String', ["open", "click"])
+      validator = EnumAttributeValidator.new('String', ['open', 'click'])
       unless validator.valid?(winner_criteria)
-        fail ArgumentError, "invalid value for 'winner_criteria', must be one of #{validator.allowable_values}."
+        fail ArgumentError, 'invalid value for "winner_criteria", must be one of #{validator.allowable_values}.'
       end
       @winner_criteria = winner_criteria
     end
@@ -361,18 +397,31 @@ module SibApiV3Sdk
     # Custom attribute writer method with validation
     # @param [Object] winner_delay Value to be assigned
     def winner_delay=(winner_delay)
-
       if !winner_delay.nil? && winner_delay > 168
-        fail ArgumentError, "invalid value for 'winner_delay', must be smaller than or equal to 168."
+        fail ArgumentError, 'invalid value for "winner_delay", must be smaller than or equal to 168.'
       end
 
       if !winner_delay.nil? && winner_delay < 1
-        fail ArgumentError, "invalid value for 'winner_delay', must be greater than or equal to 1."
+        fail ArgumentError, 'invalid value for "winner_delay", must be greater than or equal to 1.'
       end
 
       @winner_delay = winner_delay
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] increase_rate Value to be assigned
+    def increase_rate=(increase_rate)
+      if !increase_rate.nil? && increase_rate > 100
+        fail ArgumentError, 'invalid value for "increase_rate", must be smaller than or equal to 100.'
+      end
+
+      if !increase_rate.nil? && increase_rate < 0
+        fail ArgumentError, 'invalid value for "increase_rate", must be greater than or equal to 0.'
+      end
+
+      @increase_rate = increase_rate
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -402,7 +451,10 @@ module SibApiV3Sdk
           subject_b == o.subject_b &&
           split_rule == o.split_rule &&
           winner_criteria == o.winner_criteria &&
-          winner_delay == o.winner_delay
+          winner_delay == o.winner_delay &&
+          ip_warmup_enable == o.ip_warmup_enable &&
+          initial_quota == o.initial_quota &&
+          increase_rate == o.increase_rate
     end
 
     # @see the `==` method
@@ -414,7 +466,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [tag, sender, name, html_content, html_url, template_id, scheduled_at, subject, reply_to, to_field, recipients, attachment_url, inline_image_activation, mirror_active, footer, header, utm_campaign, params, send_at_best_time, ab_testing, subject_a, subject_b, split_rule, winner_criteria, winner_delay].hash
+      [tag, sender, name, html_content, html_url, template_id, scheduled_at, subject, reply_to, to_field, recipients, attachment_url, inline_image_activation, mirror_active, footer, header, utm_campaign, params, send_at_best_time, ab_testing, subject_a, subject_b, split_rule, winner_criteria, winner_delay, ip_warmup_enable, initial_quota, increase_rate].hash
     end
 
     # Builds the object from hash
@@ -427,7 +479,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]]))
@@ -509,7 +561,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) }
@@ -520,7 +572,5 @@ module SibApiV3Sdk
         value
       end
     end
-
   end
-
 end

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

@@ -1,12 +1,12 @@
 =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
 
@@ -21,7 +21,6 @@ module SibApiV3Sdk
     # Mandatory if scheduledAt is not empty. List Ids to send the campaign to
     attr_accessor :list_ids
 
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -44,7 +43,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?(:'exclusionListIds')
         if (value = attributes[:'exclusionListIds']).is_a?(Array)
@@ -57,20 +56,19 @@ module SibApiV3Sdk
           self.list_ids = 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
-      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 true
+      true
     end
 
     # Checks equality by comparing each attribute.
@@ -104,7 +102,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]]))
@@ -186,7 +184,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) }
@@ -197,7 +195,5 @@ module SibApiV3Sdk
         value
       end
     end
-
   end
-
 end

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

@@ -1,19 +1,19 @@
 =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
-  # Sender details including email and name (optional). For example {'name':'xyz' , 'email':'example@abc.com'}
+  # Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` , `{\"name\":\"xyz\", \"id\":123}`
   class CreateEmailCampaignSender
     # Sender Name
     attr_accessor :name
@@ -21,12 +21,15 @@ module SibApiV3Sdk
     # Sender email
     attr_accessor :email
 
+    # Select the sender for the campaign on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email).
+    attr_accessor :id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
-        :'email' => :'email'
+        :'email' => :'email',
+        :'id' => :'id'
       }
     end
 
@@ -34,7 +37,8 @@ module SibApiV3Sdk
     def self.swagger_types
       {
         :'name' => :'String',
-        :'email' => :'String'
+        :'email' => :'String',
+        :'id' => :'Integer'
       }
     end
 
@@ -44,7 +48,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?(:'name')
         self.name = attributes[:'name']
@@ -54,6 +58,9 @@ module SibApiV3Sdk
         self.email = attributes[:'email']
       end
 
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -61,17 +68,17 @@ module SibApiV3Sdk
     def list_invalid_properties
       invalid_properties = Array.new
       if @email.nil?
-        invalid_properties.push("invalid value for 'email', email cannot be nil.")
+        invalid_properties.push('invalid value for "email", email 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 @email.nil?
-      return true
+      true
     end
 
     # Checks equality by comparing each attribute.
@@ -80,7 +87,8 @@ module SibApiV3Sdk
       return true if self.equal?(o)
       self.class == o.class &&
           name == o.name &&
-          email == o.email
+          email == o.email &&
+          id == o.id
     end
 
     # @see the `==` method
@@ -92,7 +100,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [name, email].hash
+      [name, email, id].hash
     end
 
     # Builds the object from hash
@@ -105,7 +113,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]]))
@@ -187,7 +195,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) }
@@ -198,7 +206,5 @@ module SibApiV3Sdk
         value
       end
     end
-
   end
-
 end