sib-api-v3-sdk 5.2.0 → 5.2.1

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

@@ -27,6 +27,9 @@ module SibApiV3Sdk
     # Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted)
     attr_accessor :sms_blacklisted
 
+    # Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ)
+    attr_accessor :created_at
+
     # Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ)
     attr_accessor :modified_at
 
@@ -45,6 +48,7 @@ module SibApiV3Sdk
         :'id' => :'id',
         :'email_blacklisted' => :'emailBlacklisted',
         :'sms_blacklisted' => :'smsBlacklisted',
+        :'created_at' => :'createdAt',
         :'modified_at' => :'modifiedAt',
         :'list_ids' => :'listIds',
         :'list_unsubscribed' => :'listUnsubscribed',
@@ -59,6 +63,7 @@ module SibApiV3Sdk
         :'id' => :'Integer',
         :'email_blacklisted' => :'BOOLEAN',
         :'sms_blacklisted' => :'BOOLEAN',
+        :'created_at' => :'DateTime',
         :'modified_at' => :'DateTime',
         :'list_ids' => :'Array<Integer>',
         :'list_unsubscribed' => :'Array<Integer>',
@@ -90,6 +95,10 @@ module SibApiV3Sdk
         self.sms_blacklisted = attributes[:'smsBlacklisted']
       end
 
+      if attributes.has_key?(:'createdAt')
+        self.created_at = attributes[:'createdAt']
+      end
+
       if attributes.has_key?(:'modifiedAt')
         self.modified_at = attributes[:'modifiedAt']
       end
@@ -132,6 +141,10 @@ module SibApiV3Sdk
         invalid_properties.push("invalid value for 'sms_blacklisted', sms_blacklisted cannot be nil.")
       end
 
+      if @created_at.nil?
+        invalid_properties.push("invalid value for 'created_at', created_at cannot be nil.")
+      end
+
       if @modified_at.nil?
         invalid_properties.push("invalid value for 'modified_at', modified_at cannot be nil.")
       end
@@ -154,6 +167,7 @@ module SibApiV3Sdk
       return false if @id.nil?
       return false if @email_blacklisted.nil?
       return false if @sms_blacklisted.nil?
+      return false if @created_at.nil?
       return false if @modified_at.nil?
       return false if @list_ids.nil?
       return false if @attributes.nil?
@@ -169,6 +183,7 @@ module SibApiV3Sdk
           id == o.id &&
           email_blacklisted == o.email_blacklisted &&
           sms_blacklisted == o.sms_blacklisted &&
+          created_at == o.created_at &&
           modified_at == o.modified_at &&
           list_ids == o.list_ids &&
           list_unsubscribed == o.list_unsubscribed &&
@@ -184,7 +199,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [email, id, email_blacklisted, sms_blacklisted, modified_at, list_ids, list_unsubscribed, attributes].hash
+      [email, id, email_blacklisted, sms_blacklisted, created_at, modified_at, list_ids, list_unsubscribed, attributes].hash
     end
 
     # Builds the object from hash

data/lib/sib-api-v3-sdk/models/get_email_campaign.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
+
     # Retrieved the status of test email sending. (true=Test email has been sent  false=Test email has not been sent)
     attr_accessor :test_sent
 
@@ -112,6 +133,13 @@ module SibApiV3Sdk
         :'type' => :'type',
         :'status' => :'status',
         :'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',
         :'test_sent' => :'testSent',
         :'header' => :'header',
         :'footer' => :'footer',
@@ -141,6 +169,13 @@ module SibApiV3Sdk
         :'type' => :'String',
         :'status' => :'String',
         :'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',
         :'test_sent' => :'BOOLEAN',
         :'header' => :'String',
         :'footer' => :'String',
@@ -193,6 +228,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
+
       if attributes.has_key?(:'testSent')
         self.test_sent = attributes[:'testSent']
       end
@@ -275,10 +338,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
@@ -343,7 +402,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)
@@ -396,6 +454,13 @@ module SibApiV3Sdk
           type == o.type &&
           status == o.status &&
           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 &&
           test_sent == o.test_sent &&
           header == o.header &&
           footer == o.footer &&
@@ -424,7 +489,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, subject, type, status, scheduled_at, test_sent, header, footer, sender, reply_to, to_field, html_content, share_link, tag, created_at, modified_at, inline_image_activation, mirror_active, recurring, sent_date, recipients, statistics].hash
+      [id, name, subject, type, status, scheduled_at, ab_testing, subject_a, subject_b, split_rule, winner_criteria, winner_delay, send_at_best_time, test_sent, header, footer, sender, reply_to, to_field, html_content, share_link, tag, created_at, modified_at, inline_image_activation, mirror_active, recurring, sent_date, recipients, statistics].hash
     end
 
     # Builds the object from hash

data/lib/sib-api-v3-sdk/models/get_extended_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
+
     # Retrieved the status of test email sending. (true=Test email has been sent  false=Test email has not been sent)
     attr_accessor :test_sent
 
@@ -108,6 +129,13 @@ module SibApiV3Sdk
         :'type' => :'type',
         :'status' => :'status',
         :'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',
         :'test_sent' => :'testSent',
         :'header' => :'header',
         :'footer' => :'footer',
@@ -135,6 +163,13 @@ module SibApiV3Sdk
         :'type' => :'String',
         :'status' => :'String',
         :'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',
         :'test_sent' => :'BOOLEAN',
         :'header' => :'String',
         :'footer' => :'String',
@@ -185,6 +220,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
+
       if attributes.has_key?(:'testSent')
         self.test_sent = attributes[:'testSent']
       end
@@ -259,10 +322,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
@@ -319,7 +378,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)
@@ -370,6 +428,13 @@ module SibApiV3Sdk
           type == o.type &&
           status == o.status &&
           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 &&
           test_sent == o.test_sent &&
           header == o.header &&
           footer == o.footer &&
@@ -396,7 +461,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, subject, type, status, scheduled_at, test_sent, header, footer, sender, reply_to, to_field, html_content, share_link, tag, created_at, modified_at, inline_image_activation, mirror_active, recurring, sent_date].hash
+      [id, name, subject, type, status, scheduled_at, ab_testing, subject_a, subject_b, split_rule, winner_criteria, winner_delay, send_at_best_time, test_sent, header, footer, sender, reply_to, to_field, html_content, share_link, tag, created_at, modified_at, inline_image_activation, mirror_active, recurring, sent_date].hash
     end
 
     # Builds the object from hash

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

@@ -27,6 +27,9 @@ module SibApiV3Sdk
     # Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted)
     attr_accessor :sms_blacklisted
 
+    # Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ)
+    attr_accessor :created_at
+
     # Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ)
     attr_accessor :modified_at
 
@@ -47,6 +50,7 @@ module SibApiV3Sdk
         :'id' => :'id',
         :'email_blacklisted' => :'emailBlacklisted',
         :'sms_blacklisted' => :'smsBlacklisted',
+        :'created_at' => :'createdAt',
         :'modified_at' => :'modifiedAt',
         :'list_ids' => :'listIds',
         :'list_unsubscribed' => :'listUnsubscribed',
@@ -62,6 +66,7 @@ module SibApiV3Sdk
         :'id' => :'Integer',
         :'email_blacklisted' => :'BOOLEAN',
         :'sms_blacklisted' => :'BOOLEAN',
+        :'created_at' => :'DateTime',
         :'modified_at' => :'DateTime',
         :'list_ids' => :'Array<Integer>',
         :'list_unsubscribed' => :'Array<Integer>',
@@ -94,6 +99,10 @@ module SibApiV3Sdk
         self.sms_blacklisted = attributes[:'smsBlacklisted']
       end
 
+      if attributes.has_key?(:'createdAt')
+        self.created_at = attributes[:'createdAt']
+      end
+
       if attributes.has_key?(:'modifiedAt')
         self.modified_at = attributes[:'modifiedAt']
       end
@@ -140,6 +149,10 @@ module SibApiV3Sdk
         invalid_properties.push("invalid value for 'sms_blacklisted', sms_blacklisted cannot be nil.")
       end
 
+      if @created_at.nil?
+        invalid_properties.push("invalid value for 'created_at', created_at cannot be nil.")
+      end
+
       if @modified_at.nil?
         invalid_properties.push("invalid value for 'modified_at', modified_at cannot be nil.")
       end
@@ -166,6 +179,7 @@ module SibApiV3Sdk
       return false if @id.nil?
       return false if @email_blacklisted.nil?
       return false if @sms_blacklisted.nil?
+      return false if @created_at.nil?
       return false if @modified_at.nil?
       return false if @list_ids.nil?
       return false if @attributes.nil?
@@ -182,6 +196,7 @@ module SibApiV3Sdk
           id == o.id &&
           email_blacklisted == o.email_blacklisted &&
           sms_blacklisted == o.sms_blacklisted &&
+          created_at == o.created_at &&
           modified_at == o.modified_at &&
           list_ids == o.list_ids &&
           list_unsubscribed == o.list_unsubscribed &&
@@ -198,7 +213,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [email, id, email_blacklisted, sms_blacklisted, modified_at, list_ids, list_unsubscribed, attributes, statistics].hash
+      [email, id, email_blacklisted, sms_blacklisted, created_at, modified_at, list_ids, list_unsubscribed, attributes, statistics].hash
     end
 
     # Builds the object from hash

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

@@ -18,7 +18,7 @@ module SibApiV3Sdk
     # List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email'].
     attr_accessor :export_attributes
 
-    # Set the filter for the contacts to be exported. For example, {'blacklisted':true} will export all the blacklisted contacts.
+    # Set the filter for the contacts to be exported. For example, `{\"blacklisted\":true}` will export all the blacklisted contacts.
     attr_accessor :contact_filter
 
     # Webhook that will be called once the export process is finished

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

@@ -30,13 +30,13 @@ module SibApiV3Sdk
     # 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
     attr_accessor :attachment_url
 
-    # Pass the list of content (base64 encoded) and name of the attachment. For example, [{'content':'base64 encoded content 1', 'name':'attcahment1'}, {'content':'base64 encoded content 2', 'name':'attcahment2'}].
+    # Pass the list of content (base64 encoded) and name of the attachment. For example, `[{\"content\":\"base64 encoded content 1\", \"name\":\"attcahment1\"}, {\"content\":\"base64 encoded content 2\", \"name\":\"attcahment2\"}]`
     attr_accessor :attachment
 
-    # Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'}
+    # Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, `{\"Content-Type\":\"text/html\", \"charset\":\"iso-8859-1\", \"sender.ip\":\"1.2.3.4\"}`
     attr_accessor :headers
 
-    # Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}
+    # Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}
     attr_accessor :attributes
 
     # Tag your emails to find them more easily

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

@@ -17,7 +17,7 @@ module SibApiV3Sdk
   class SendSmtpEmail
     attr_accessor :sender
 
-    # List of email addresses and names (optional) of the recipients. For example, [{'name':'Jimmy', 'email':'jimmy98@example.com'}, {'name':'Joe', 'email':'joe@example.com'}]
+    # List of email addresses and names (optional) of the recipients. For example, `[{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}]`
     attr_accessor :to
 
     # List of email addresses and names (optional) of the recipients in bcc
@@ -37,16 +37,16 @@ module SibApiV3Sdk
 
     attr_accessor :reply_to
 
-    # Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, [{'url':'https://attachment.domain.com/myAttachmentFromUrl.jpg', 'name':'My attachment 1'}, {'content':'base64 exmaple content', 'name':'My attachment 2'}]. Allowed extensions for attachment file: 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, eps and odt ( Ignored if 'templateId' is passed )
+    # Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"My attachment 1\"}, {\"content\":\"base64 exmaple content\", \"name\":\"My attachment 2\"}]`. Allowed extensions for attachment file: 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, eps and odt ( If 'templateId' is passed and is in New Template Language format then only attachment url is accepted. If template is in Old template Language format, then 'attachment' is ignored )
     attr_accessor :attachment
 
-    # Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'}
+    # Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, `{\"Content-Type\":\"text/html\", \"charset\":\"iso-8859-1\", \"sender.ip\":\"1.2.3.4\"}`
     attr_accessor :headers
 
     # Id of the template
     attr_accessor :template_id
 
-    # Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. It's considered only if template is in New Template Language format.
+    # Pass the set of attributes to customize the template. For example, `{\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}`. It's considered only if template is in New Template Language format.
     attr_accessor :params
 
     # Tag your emails to find them more easily