sib-api-v3-sdk 5.2.0 → 5.2.1

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

@@ -86,7 +86,7 @@ module SibApiV3Sdk
 
       # http body (model)
       post_body = nil
-      auth_names = ['api-key']
+      auth_names = ['api-key', 'partner-key']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -147,7 +147,7 @@ module SibApiV3Sdk
 
       # http body (model)
       post_body = nil
-      auth_names = ['api-key']
+      auth_names = ['api-key', 'partner-key']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -208,7 +208,7 @@ module SibApiV3Sdk
 
       # http body (model)
       post_body = nil
-      auth_names = ['api-key']
+      auth_names = ['api-key', 'partner-key']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -263,7 +263,7 @@ module SibApiV3Sdk
 
       # http body (model)
       post_body = @api_client.object_to_http_body(send_transac_sms)
-      auth_names = ['api-key']
+      auth_names = ['api-key', 'partner-key']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,

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

@@ -61,7 +61,7 @@ module SibApiV3Sdk
 
       # http body (model)
       post_body = @api_client.object_to_http_body(create_webhook)
-      auth_names = ['api-key']
+      auth_names = ['api-key', 'partner-key']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -116,7 +116,7 @@ module SibApiV3Sdk
 
       # http body (model)
       post_body = nil
-      auth_names = ['api-key']
+      auth_names = ['api-key', 'partner-key']
       data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -170,7 +170,7 @@ module SibApiV3Sdk
 
       # http body (model)
       post_body = nil
-      auth_names = ['api-key']
+      auth_names = ['api-key', 'partner-key']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -225,7 +225,7 @@ module SibApiV3Sdk
 
       # http body (model)
       post_body = nil
-      auth_names = ['api-key']
+      auth_names = ['api-key', 'partner-key']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -286,7 +286,7 @@ module SibApiV3Sdk
 
       # http body (model)
       post_body = @api_client.object_to_http_body(update_webhook)
-      auth_names = ['api-key']
+      auth_names = ['api-key', 'partner-key']
       data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
         :header_params => header_params,
         :query_params => query_params,

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

@@ -203,6 +203,13 @@ module SibApiV3Sdk
             key: 'api-key',
             value: api_key_with_prefix('api-key')
           },
+        'partner-key' =>
+          {
+            type: 'api_key',
+            in: 'header',
+            key: 'partner-key',
+            value: api_key_with_prefix('partner-key')
+          },
       }
     end
   end

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

@@ -18,7 +18,7 @@ module SibApiV3Sdk
     # Value of the attribute. Use only if the attribute's category is 'calculated' or 'global'
     attr_accessor :value
 
-    # List of 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 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
 
     # Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute )

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

@@ -18,7 +18,7 @@ module SibApiV3Sdk
     # Email address of the user. Mandatory if \"sms\" field is not passed in \"attributes\" parameter'
     attr_accessor :email
 
-    # Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'}
+    # Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For example, `{\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"}`
     attr_accessor :attributes
 
     # Set this field to blacklist the contact for emails (emailBlacklisted = true)

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

@@ -35,13 +35,13 @@ module SibApiV3Sdk
     # Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part).
     attr_accessor :scheduled_at
 
-    # Subject of the campaign
+    # Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true.
     attr_accessor :subject
 
     # Email on which the 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'}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. 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\"}`. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. 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.
     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 when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & '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. Mandatory if abTesting = true. subjectA & subjectB should have unique value
+    attr_accessor :subject_a
+
+    # Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value
+    attr_accessor :subject_b
+
+    # Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. 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. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed
+    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. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed
+    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,6 +260,32 @@ module SibApiV3Sdk
         self.send_at_best_time = false
       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?
@@ -223,8 +300,20 @@ module SibApiV3Sdk
         invalid_properties.push("invalid value for 'name', name cannot be nil.")
       end
 
-      if @subject.nil?
-        invalid_properties.push("invalid value for 'subject', subject cannot be nil.")
+      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
@@ -235,10 +324,55 @@ module SibApiV3Sdk
     def valid?
       return false if @sender.nil?
       return false if @name.nil?
-      return false if @subject.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"])
+      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)
@@ -262,7 +396,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
@@ -274,7 +414,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].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
     end
 
     # Builds the object from hash

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

@@ -13,7 +13,7 @@ Swagger Codegen version: 2.3.1
 require 'date'
 
 module SibApiV3Sdk
-  # Sender details including email and name (optional). For example {'name':'xyz' , 'email':'example@abc.com'}
+  # Sender details including email and name (optional). For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}`
   class CreateEmailCampaignSender
     # Sender Name
     attr_accessor :name

data/lib/sib-api-v3-sdk/models/create_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/create_smtp_template_sender.rb

@@ -13,7 +13,7 @@ Swagger Codegen version: 2.3.1
 require 'date'
 
 module SibApiV3Sdk
-  # Sender details including email and name (optional). For example {'name':'xyz' , 'email':'example@abc.com'}
+  # Sender details including email and name (optional). For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}`
   class CreateSmtpTemplateSender
     # Name of the sender. If not passed, will be set to default
     attr_accessor :name

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

@@ -21,7 +21,7 @@ module SibApiV3Sdk
     # Name of the campaign
     attr_accessor :name
 
-    # Subject of the campaign
+    # Subject of the campaign. Only available if `abTesting` flag of the campaign is `false`
     attr_accessor :subject
 
     # Type of campaign
@@ -33,6 +33,27 @@ module SibApiV3Sdk
     # UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ)
     attr_accessor :scheduled_at
 
+    # Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled.
+    attr_accessor :ab_testing
+
+    # Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
+    attr_accessor :subject_a
+
+    # Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
+    attr_accessor :subject_b
+
+    # The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true`
+    attr_accessor :split_rule
+
+    # Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true`
+    attr_accessor :winner_criteria
+
+    # The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true`
+    attr_accessor :winner_delay
+
+    # It is true if you have chosen to send your campaign at best time, otherwise it is false
+    attr_accessor :send_at_best_time
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -63,7 +84,14 @@ module SibApiV3Sdk
         :'subject' => :'subject',
         :'type' => :'type',
         :'status' => :'status',
-        :'scheduled_at' => :'scheduledAt'
+        :'scheduled_at' => :'scheduledAt',
+        :'ab_testing' => :'abTesting',
+        :'subject_a' => :'subjectA',
+        :'subject_b' => :'subjectB',
+        :'split_rule' => :'splitRule',
+        :'winner_criteria' => :'winnerCriteria',
+        :'winner_delay' => :'winnerDelay',
+        :'send_at_best_time' => :'sendAtBestTime'
       }
     end
 
@@ -75,7 +103,14 @@ module SibApiV3Sdk
         :'subject' => :'String',
         :'type' => :'String',
         :'status' => :'String',
-        :'scheduled_at' => :'DateTime'
+        :'scheduled_at' => :'DateTime',
+        :'ab_testing' => :'BOOLEAN',
+        :'subject_a' => :'String',
+        :'subject_b' => :'String',
+        :'split_rule' => :'Integer',
+        :'winner_criteria' => :'String',
+        :'winner_delay' => :'Integer',
+        :'send_at_best_time' => :'BOOLEAN'
       }
     end
 
@@ -111,6 +146,34 @@ module SibApiV3Sdk
         self.scheduled_at = attributes[:'scheduledAt']
       end
 
+      if attributes.has_key?(:'abTesting')
+        self.ab_testing = attributes[:'abTesting']
+      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
+
+      if attributes.has_key?(:'sendAtBestTime')
+        self.send_at_best_time = attributes[:'sendAtBestTime']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -125,10 +188,6 @@ module SibApiV3Sdk
         invalid_properties.push("invalid value for 'name', name cannot be nil.")
       end
 
-      if @subject.nil?
-        invalid_properties.push("invalid value for 'subject', subject cannot be nil.")
-      end
-
       if @type.nil?
         invalid_properties.push("invalid value for 'type', type cannot be nil.")
       end
@@ -145,7 +204,6 @@ module SibApiV3Sdk
     def valid?
       return false if @id.nil?
       return false if @name.nil?
-      return false if @subject.nil?
       return false if @type.nil?
       type_validator = EnumAttributeValidator.new('String', ["classic", "trigger"])
       return false unless type_validator.valid?(@type)
@@ -185,7 +243,14 @@ module SibApiV3Sdk
           subject == o.subject &&
           type == o.type &&
           status == o.status &&
-          scheduled_at == o.scheduled_at
+          scheduled_at == o.scheduled_at &&
+          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 &&
+          send_at_best_time == o.send_at_best_time
     end
 
     # @see the `==` method
@@ -197,7 +262,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, subject, type, status, scheduled_at].hash
+      [id, name, subject, type, status, scheduled_at, ab_testing, subject_a, subject_b, split_rule, winner_criteria, winner_delay, send_at_best_time].hash
     end
 
     # Builds the object from hash