sib-api-v3-sdk 7.2.0 → 8.0.0

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

@@ -6,7 +6,7 @@
 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.12
+Swagger Codegen version: 2.4.19
 
 =end
 
@@ -108,7 +108,7 @@ module SibApiV3Sdk
       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 the attribute
+          # 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) })
@@ -204,5 +204,6 @@ module SibApiV3Sdk
         value
       end
     end
+
   end
 end

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

@@ -6,7 +6,7 @@
 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.12
+Swagger Codegen version: 2.4.19
 
 =end
 
@@ -94,7 +94,7 @@ module SibApiV3Sdk
       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 the attribute
+          # 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) })
@@ -190,5 +190,6 @@ module SibApiV3Sdk
         value
       end
     end
+
   end
 end

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

@@ -6,7 +6,7 @@
 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.12
+Swagger Codegen version: 2.4.19
 
 =end
 
@@ -17,9 +17,6 @@ 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
 
-    # This attribute has been deprecated and will be removed by January 1st, 2021. Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported. For example, {\"blacklisted\":true} will export all the blacklisted contacts. 
-    attr_accessor :contact_filter
-
     attr_accessor :custom_contact_filter
 
     # Webhook that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479
@@ -29,7 +26,6 @@ module SibApiV3Sdk
     def self.attribute_map
       {
         :'export_attributes' => :'exportAttributes',
-        :'contact_filter' => :'contactFilter',
         :'custom_contact_filter' => :'customContactFilter',
         :'notify_url' => :'notifyUrl'
       }
@@ -39,7 +35,6 @@ module SibApiV3Sdk
     def self.swagger_types
       {
         :'export_attributes' => :'Array<String>',
-        :'contact_filter' => :'Object',
         :'custom_contact_filter' => :'RequestContactExportCustomContactFilter',
         :'notify_url' => :'String'
       }
@@ -59,10 +54,6 @@ module SibApiV3Sdk
         end
       end
 
-      if attributes.has_key?(:'contactFilter')
-        self.contact_filter = attributes[:'contactFilter']
-      end
-
       if attributes.has_key?(:'customContactFilter')
         self.custom_contact_filter = attributes[:'customContactFilter']
       end
@@ -76,12 +67,17 @@ module SibApiV3Sdk
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @custom_contact_filter.nil?
+        invalid_properties.push('invalid value for "custom_contact_filter", custom_contact_filter cannot be nil.')
+      end
+
       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 @custom_contact_filter.nil?
       true
     end
 
@@ -91,7 +87,6 @@ module SibApiV3Sdk
       return true if self.equal?(o)
       self.class == o.class &&
           export_attributes == o.export_attributes &&
-          contact_filter == o.contact_filter &&
           custom_contact_filter == o.custom_contact_filter &&
           notify_url == o.notify_url
     end
@@ -105,7 +100,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [export_attributes, contact_filter, custom_contact_filter, notify_url].hash
+      [export_attributes, custom_contact_filter, notify_url].hash
     end
 
     # Builds the object from hash
@@ -115,7 +110,7 @@ module SibApiV3Sdk
       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 the attribute
+          # 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) })
@@ -211,5 +206,6 @@ module SibApiV3Sdk
         value
       end
     end
+
   end
 end

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

@@ -6,14 +6,14 @@
 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.12
+Swagger Codegen version: 2.4.19
 
 =end
 
 require 'date'
 
 module SibApiV3Sdk
-  # Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported.
+  # Set the filter for the contacts to be exported.
   class RequestContactExportCustomContactFilter
     # Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on contacts as per the list id. * allContacts - Fetch the list of all contacts for a particular list. * subscribed & unsubscribed - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * unsubscribedPerList - Fetch the list of contacts that are unsubscribed from a particular list only. 
     attr_accessor :action_for_contacts
@@ -193,7 +193,7 @@ module SibApiV3Sdk
       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 the attribute
+          # 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) })
@@ -289,5 +289,6 @@ module SibApiV3Sdk
         value
       end
     end
+
   end
 end

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

@@ -6,7 +6,7 @@
 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.12
+Swagger Codegen version: 2.4.19
 
 =end
 
@@ -173,7 +173,7 @@ module SibApiV3Sdk
       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 the attribute
+          # 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) })
@@ -269,5 +269,6 @@ module SibApiV3Sdk
         value
       end
     end
+
   end
 end

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

@@ -6,7 +6,7 @@
 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.12
+Swagger Codegen version: 2.4.19
 
 =end
 
@@ -95,7 +95,7 @@ module SibApiV3Sdk
       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 the attribute
+          # 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) })
@@ -191,5 +191,6 @@ module SibApiV3Sdk
         value
       end
     end
+
   end
 end

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

@@ -6,7 +6,7 @@
 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.12
+Swagger Codegen version: 2.4.19
 
 =end
 
@@ -133,7 +133,7 @@ module SibApiV3Sdk
       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 the attribute
+          # 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) })
@@ -229,5 +229,6 @@ module SibApiV3Sdk
         value
       end
     end
+
   end
 end

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

@@ -6,7 +6,7 @@
 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.12
+Swagger Codegen version: 2.4.19
 
 =end
 
@@ -134,7 +134,7 @@ module SibApiV3Sdk
       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 the attribute
+          # 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) })
@@ -230,5 +230,6 @@ module SibApiV3Sdk
         value
       end
     end
+
   end
 end

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

@@ -6,7 +6,7 @@
 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.12
+Swagger Codegen version: 2.4.19
 
 =end
 
@@ -107,7 +107,7 @@ module SibApiV3Sdk
       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 the attribute
+          # 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) })
@@ -203,5 +203,6 @@ module SibApiV3Sdk
         value
       end
     end
+
   end
 end

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

@@ -6,7 +6,7 @@
 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.12
+Swagger Codegen version: 2.4.19
 
 =end
 
@@ -132,7 +132,7 @@ module SibApiV3Sdk
       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 the attribute
+          # 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) })
@@ -228,5 +228,6 @@ module SibApiV3Sdk
         value
       end
     end
+
   end
 end

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

@@ -6,7 +6,7 @@
 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.12
+Swagger Codegen version: 2.4.19
 
 =end
 
@@ -16,7 +16,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\"}]
+    # Mandatory if messageVersions are not passed, ignored if messageVersions are passed. 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
@@ -36,18 +36,21 @@ 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\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. 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, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored )
+    # 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\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. 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, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv and pkpass ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored )
     attr_accessor :attachment
 
-    # Pass the set of custom headers (not the standard 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. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`.
+    # Pass the set of custom headers (not the standard 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. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\", \"idempotencyKey\":\"abc-123\"}`.
     attr_accessor :headers
 
-    # Id of the template
+    # Id of the template. Mandatory if messageVersions are passed
     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.
     attr_accessor :params
 
+    # You can customize and send out multiple versions of a templateId. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. Total number of recipients in one API request must not exceed 200. However, you can still pass upto 99 recipients maximum in one message version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. This feature is currently in its beta version. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails
+    attr_accessor :message_versions
+
     # Tag your emails to find them more easily
     attr_accessor :tags
 
@@ -66,6 +69,7 @@ module SibApiV3Sdk
         :'headers' => :'headers',
         :'template_id' => :'templateId',
         :'params' => :'params',
+        :'message_versions' => :'messageVersions',
         :'tags' => :'tags'
       }
     end
@@ -85,6 +89,7 @@ module SibApiV3Sdk
         :'headers' => :'Object',
         :'template_id' => :'Integer',
         :'params' => :'Object',
+        :'message_versions' => :'Array<SendSmtpEmailMessageVersions>',
         :'tags' => :'Array<String>'
       }
     end
@@ -153,6 +158,12 @@ module SibApiV3Sdk
         self.params = attributes[:'params']
       end
 
+      if attributes.has_key?(:'messageVersions')
+        if (value = attributes[:'messageVersions']).is_a?(Array)
+          self.message_versions = value
+        end
+      end
+
       if attributes.has_key?(:'tags')
         if (value = attributes[:'tags']).is_a?(Array)
           self.tags = value
@@ -164,17 +175,12 @@ module SibApiV3Sdk
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @to.nil?
-        invalid_properties.push('invalid value for "to", to cannot be nil.')
-      end
-
       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 @to.nil?
       true
     end
 
@@ -195,6 +201,7 @@ module SibApiV3Sdk
           headers == o.headers &&
           template_id == o.template_id &&
           params == o.params &&
+          message_versions == o.message_versions &&
           tags == o.tags
     end
 
@@ -207,7 +214,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [sender, to, bcc, cc, html_content, text_content, subject, reply_to, attachment, headers, template_id, params, tags].hash
+      [sender, to, bcc, cc, html_content, text_content, subject, reply_to, attachment, headers, template_id, params, message_versions, tags].hash
     end
 
     # Builds the object from hash
@@ -217,7 +224,7 @@ module SibApiV3Sdk
       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 the attribute
+          # 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) })
@@ -313,5 +320,6 @@ module SibApiV3Sdk
         value
       end
     end
+
   end
 end

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

@@ -6,7 +6,7 @@
 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.12
+Swagger Codegen version: 2.4.19
 
 =end
 
@@ -119,7 +119,7 @@ module SibApiV3Sdk
       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 the attribute
+          # 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) })
@@ -215,5 +215,6 @@ module SibApiV3Sdk
         value
       end
     end
+
   end
 end

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

@@ -6,7 +6,7 @@
 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.12
+Swagger Codegen version: 2.4.19
 
 =end
 
@@ -99,7 +99,7 @@ module SibApiV3Sdk
       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 the attribute
+          # 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) })
@@ -195,5 +195,6 @@ module SibApiV3Sdk
         value
       end
     end
+
   end
 end

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

@@ -6,7 +6,7 @@
 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.12
+Swagger Codegen version: 2.4.19
 
 =end
 
@@ -99,7 +99,7 @@ module SibApiV3Sdk
       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 the attribute
+          # 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) })
@@ -195,5 +195,6 @@ module SibApiV3Sdk
         value
       end
     end
+
   end
 end