sib-api-v3-sdk 5.2.0 → 5.2.1

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

@@ -13,7 +13,7 @@ Swagger Codegen version: 2.3.1
 require 'date'
 
 module SibApiV3Sdk
-  # Email (required), along with name (optional), on which transactional mail recipients will be able to reply back. For example, {'email':'ann6533@example.com', 'name':'Ann'}.
+  # Email (required), along with name (optional), on which transactional mail recipients will be able to reply back. For example, `{\"email':'ann6533@example.com', 'name':'Ann'}`
   class SendSmtpEmailReplyTo
     # Email address in reply to
     attr_accessor :email

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

@@ -13,7 +13,7 @@ Swagger Codegen version: 2.3.1
 require 'date'
 
 module SibApiV3Sdk
-  # Mandatory if 'templateId' is not passed. Pass name (optional) and email of sender from which emails will be sent. For example, {'name':'Mary from MyShop', 'email':'no-reply@myshop.com'}
+  # Mandatory if 'templateId' is not passed. Pass name (optional) and email of sender from which emails will be sent. For example, `{\"name\":\"Mary from MyShop\", \"email\":\"no-reply@myshop.com\"}`
   class SendSmtpEmailSender
     # Name of the sender from which the emails will be sent
     attr_accessor :name

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

@@ -18,7 +18,7 @@ module SibApiV3Sdk
     # Value of the attribute to update. Use only if the attribute's category is 'calculated' or 'global'
     attr_accessor :value
 
-    # List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}]
+    # List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, `[{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}]`
     attr_accessor :enumeration
 
 

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

@@ -15,7 +15,7 @@ require 'date'
 module SibApiV3Sdk
 
   class UpdateContact
-    # Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For eg. { 'EMAIL':'newemail@domain.com', 'FNAME':'Ellie', 'LNAME':'Roger'}
+    # Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, `{ 'EMAIL':'newemail@domain.com', 'FNAME':'Ellie', 'LNAME':'Roger'}`
     attr_accessor :attributes
 
     # Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true)

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

@@ -38,7 +38,7 @@ module SibApiV3Sdk
     # Email on which campaign recipients will be able to reply to
     attr_accessor :reply_to
 
-    # To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
+    # To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization
     attr_accessor :to_field
 
     attr_accessor :recipients
@@ -64,12 +64,51 @@ module SibApiV3Sdk
     # Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed
     attr_accessor :utm_campaign
 
-    # Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField'
+    # Pass the set of attributes to customize the type 'classic' campaign. For example, `{\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}`. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField'
     attr_accessor :params
 
     # Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled.
     attr_accessor :send_at_best_time
 
+    # Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered if abTesting is set to true. 'subject' if passed is ignored.  Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B
+    attr_accessor :ab_testing
+
+    # Subject A of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value
+    attr_accessor :subject_a
+
+    # Subject B of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value
+    attr_accessor :subject_b
+
+    # Add the size of your test groups. Considered if abTesting = true. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else
+    attr_accessor :split_rule
+
+    # Choose the metrics that will determinate the winning version. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed or alreday exist in record
+    attr_accessor :winner_criteria
+
+    # 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. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed or alreday exist in record
+    attr_accessor :winner_delay
+
+    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
@@ -92,7 +131,13 @@ module SibApiV3Sdk
         :'header' => :'header',
         :'utm_campaign' => :'utmCampaign',
         :'params' => :'params',
-        :'send_at_best_time' => :'sendAtBestTime'
+        :'send_at_best_time' => :'sendAtBestTime',
+        :'ab_testing' => :'abTesting',
+        :'subject_a' => :'subjectA',
+        :'subject_b' => :'subjectB',
+        :'split_rule' => :'splitRule',
+        :'winner_criteria' => :'winnerCriteria',
+        :'winner_delay' => :'winnerDelay'
       }
     end
 
@@ -117,7 +162,13 @@ module SibApiV3Sdk
         :'header' => :'String',
         :'utm_campaign' => :'String',
         :'params' => :'Object',
-        :'send_at_best_time' => :'BOOLEAN'
+        :'send_at_best_time' => :'BOOLEAN',
+        :'ab_testing' => :'BOOLEAN',
+        :'subject_a' => :'String',
+        :'subject_b' => :'String',
+        :'split_rule' => :'Integer',
+        :'winner_criteria' => :'String',
+        :'winner_delay' => :'Integer'
       }
     end
 
@@ -209,21 +260,109 @@ module SibApiV3Sdk
         self.send_at_best_time = attributes[:'sendAtBestTime']
       end
 
+      if attributes.has_key?(:'abTesting')
+        self.ab_testing = attributes[:'abTesting']
+      else
+        self.ab_testing = false
+      end
+
+      if attributes.has_key?(:'subjectA')
+        self.subject_a = attributes[:'subjectA']
+      end
+
+      if attributes.has_key?(:'subjectB')
+        self.subject_b = attributes[:'subjectB']
+      end
+
+      if attributes.has_key?(:'splitRule')
+        self.split_rule = attributes[:'splitRule']
+      end
+
+      if attributes.has_key?(:'winnerCriteria')
+        self.winner_criteria = attributes[:'winnerCriteria']
+      end
+
+      if attributes.has_key?(:'winnerDelay')
+        self.winner_delay = attributes[:'winnerDelay']
+      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 !@split_rule.nil? && @split_rule > 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.")
+      end
+
+      if !@winner_delay.nil? && @winner_delay > 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.")
+      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 !@split_rule.nil? && @split_rule > 50
+      return false if !@split_rule.nil? && @split_rule < 1
+      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
     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."
+      end
+
+      if !split_rule.nil? && split_rule < 1
+        fail ArgumentError, "invalid value for 'split_rule', must be greater than or equal to 1."
+      end
+
+      @split_rule = split_rule
+    end
+
+    # 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"])
+      unless validator.valid?(winner_criteria)
+        fail ArgumentError, "invalid value for 'winner_criteria', must be one of #{validator.allowable_values}."
+      end
+      @winner_criteria = winner_criteria
+    end
+
+    # 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."
+      end
+
+      if !winner_delay.nil? && winner_delay < 1
+        fail ArgumentError, "invalid value for 'winner_delay', must be greater than or equal to 1."
+      end
+
+      @winner_delay = winner_delay
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -247,7 +386,13 @@ module SibApiV3Sdk
           header == o.header &&
           utm_campaign == o.utm_campaign &&
           params == o.params &&
-          send_at_best_time == o.send_at_best_time
+          send_at_best_time == o.send_at_best_time &&
+          ab_testing == o.ab_testing &&
+          subject_a == o.subject_a &&
+          subject_b == o.subject_b &&
+          split_rule == o.split_rule &&
+          winner_criteria == o.winner_criteria &&
+          winner_delay == o.winner_delay
     end
 
     # @see the `==` method
@@ -259,7 +404,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [tag, sender, name, html_content, html_url, scheduled_at, subject, reply_to, to_field, recipients, attachment_url, inline_image_activation, mirror_active, recurring, footer, header, utm_campaign, params, send_at_best_time].hash
+      [tag, sender, name, html_content, html_url, scheduled_at, subject, reply_to, to_field, recipients, attachment_url, inline_image_activation, mirror_active, recurring, footer, header, utm_campaign, params, send_at_best_time, ab_testing, subject_a, subject_b, split_rule, winner_criteria, winner_delay].hash
     end
 
     # Builds the object from hash

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

@@ -13,7 +13,7 @@ Swagger Codegen version: 2.3.1
 require 'date'
 
 module SibApiV3Sdk
-  # Sender details including email and/or name. For example {'name':'xyz' , 'email':'example@abc.com'}
+  # Sender details including email and/or name. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}`
   class UpdateEmailCampaignSender
     # Sender Name from which the campaign emails are sent
     attr_accessor :name

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

@@ -35,7 +35,7 @@ module SibApiV3Sdk
     # Email on which campaign recipients will be able to reply to
     attr_accessor :reply_to
 
-    # To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
+    # To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization
     attr_accessor :to_field
 
     # Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps

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

@@ -13,7 +13,7 @@ Swagger Codegen version: 2.3.1
 require 'date'
 
 module SibApiV3Sdk
-  # Sender details including email and/or name. For example {'name':'xyz' , 'email':'example@abc.com'}
+  # Sender details including email and/or name. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}`
   class UpdateSmtpTemplateSender
     # Name of the sender
     attr_accessor :name

data/lib/sib-api-v3-sdk/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.3.1
 =end
 
 module SibApiV3Sdk
-  VERSION = "5.2.0"
+  VERSION = "5.2.1"
 end

data/spec/models/create_email_campaign_spec.rb

@@ -146,5 +146,45 @@ describe 'CreateEmailCampaign' do
     end
   end
 
+  describe 'test attribute "ab_testing"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "subject_a"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "subject_b"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "split_rule"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "winner_criteria"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+       #validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["open", "click"])
+       #validator.allowable_values.each do |value|
+       #  expect { @instance.winner_criteria = value }.not_to raise_error
+       #end
+    end
+  end
+
+  describe 'test attribute "winner_delay"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end
 

data/spec/models/get_campaign_overview_spec.rb

@@ -76,5 +76,47 @@ describe 'GetCampaignOverview' do
     end
   end
 
+  describe 'test attribute "ab_testing"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "subject_a"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "subject_b"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "split_rule"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "winner_criteria"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "winner_delay"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "send_at_best_time"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end
 

data/spec/models/get_contact_details_spec.rb

@@ -56,6 +56,12 @@ describe 'GetContactDetails' do
     end
   end
 
+  describe 'test attribute "created_at"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "modified_at"' do
     it 'should work' do
        # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/get_email_campaign_spec.rb

@@ -76,6 +76,48 @@ describe 'GetEmailCampaign' do
     end
   end
 
+  describe 'test attribute "ab_testing"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "subject_a"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "subject_b"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "split_rule"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "winner_criteria"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "winner_delay"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "send_at_best_time"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "test_sent"' do
     it 'should work' do
        # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers