sib-api-v3-sdk 5.4.0 → 7.1.0

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

@@ -61,10 +61,6 @@ module SibApiV3Sdk
         invalid_properties.push('invalid value for "event_time", event_time cannot be nil.')
       end
 
-      if @ip.nil?
-        invalid_properties.push('invalid value for "ip", ip cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -72,7 +68,6 @@ module SibApiV3Sdk
     # @return true if the model is valid
     def valid?
       return false if @event_time.nil?
-      return false if @ip.nil?
       true
     end
 

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

@@ -74,10 +74,6 @@ module SibApiV3Sdk
         invalid_properties.push('invalid value for "event_time", event_time cannot be nil.')
       end
 
-      if @ip.nil?
-        invalid_properties.push('invalid value for "ip", ip cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -86,7 +82,6 @@ module SibApiV3Sdk
     def valid?
       return false if @campaign_id.nil?
       return false if @event_time.nil?
-      return false if @ip.nil?
       true
     end
 

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

@@ -49,6 +49,9 @@ module SibApiV3Sdk
     # Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ)
     attr_accessor :modified_at
 
+    # It is true if template is a valid Double opt-in (DOI) template, otherwise it is false. This field will be available only in case of single template detail call.
+    attr_accessor :doi_template
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -63,7 +66,8 @@ module SibApiV3Sdk
         :'tag' => :'tag',
         :'html_content' => :'htmlContent',
         :'created_at' => :'createdAt',
-        :'modified_at' => :'modifiedAt'
+        :'modified_at' => :'modifiedAt',
+        :'doi_template' => :'doiTemplate'
       }
     end
 
@@ -81,7 +85,8 @@ module SibApiV3Sdk
         :'tag' => :'String',
         :'html_content' => :'String',
         :'created_at' => :'DateTime',
-        :'modified_at' => :'DateTime'
+        :'modified_at' => :'DateTime',
+        :'doi_template' => :'BOOLEAN'
       }
     end
 
@@ -140,6 +145,10 @@ module SibApiV3Sdk
       if attributes.has_key?(:'modifiedAt')
         self.modified_at = attributes[:'modifiedAt']
       end
+
+      if attributes.has_key?(:'doiTemplate')
+        self.doi_template = attributes[:'doiTemplate']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -231,7 +240,8 @@ module SibApiV3Sdk
           tag == o.tag &&
           html_content == o.html_content &&
           created_at == o.created_at &&
-          modified_at == o.modified_at
+          modified_at == o.modified_at &&
+          doi_template == o.doi_template
     end
 
     # @see the `==` method
@@ -243,7 +253,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, subject, is_active, test_sent, sender, reply_to, to_field, tag, html_content, created_at, modified_at].hash
+      [id, name, subject, is_active, test_sent, sender, reply_to, to_field, tag, html_content, created_at, modified_at, doi_template].hash
     end
 
     # Builds the object from hash

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

@@ -21,12 +21,16 @@ module SibApiV3Sdk
     # Displays the count of total number of contacts removed from list when user opts for \"all\" option.
     attr_accessor :total
 
+    # Id of the process created to remove contacts from list when user opts for \"all\" option.
+    attr_accessor :process_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'success' => :'success',
         :'failure' => :'failure',
-        :'total' => :'total'
+        :'total' => :'total',
+        :'process_id' => :'processId'
       }
     end
 
@@ -35,7 +39,8 @@ module SibApiV3Sdk
       {
         :'success' => :'Array<String>',
         :'failure' => :'Array<String>',
-        :'total' => :'Integer'
+        :'total' => :'Integer',
+        :'process_id' => :'Integer'
       }
     end
 
@@ -62,6 +67,10 @@ module SibApiV3Sdk
       if attributes.has_key?(:'total')
         self.total = attributes[:'total']
       end
+
+      if attributes.has_key?(:'processId')
+        self.process_id = attributes[:'processId']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -84,7 +93,8 @@ module SibApiV3Sdk
       self.class == o.class &&
           success == o.success &&
           failure == o.failure &&
-          total == o.total
+          total == o.total &&
+          process_id == o.process_id
     end
 
     # @see the `==` method
@@ -96,7 +106,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [success, failure, total].hash
+      [success, failure, total, process_id].hash
     end
 
     # Builds the object from hash

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

@@ -17,13 +17,17 @@ module SibApiV3Sdk
     # Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request.
     attr_accessor :emails
 
-    # Required if 'emails' is empty. Remove all existing contacts from a list
+    # Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api.
+    attr_accessor :ids
+
+    # Required if none of 'emails' or 'ids' are passed. Remove all existing contacts from a list.  A process will be created in this scenario. You can fetch the process details to know about the progress
     attr_accessor :all
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'emails' => :'emails',
+        :'ids' => :'ids',
         :'all' => :'all'
       }
     end
@@ -32,6 +36,7 @@ module SibApiV3Sdk
     def self.swagger_types
       {
         :'emails' => :'Array<String>',
+        :'ids' => :'Array<Integer>',
         :'all' => :'BOOLEAN'
       }
     end
@@ -50,6 +55,12 @@ module SibApiV3Sdk
         end
       end
 
+      if attributes.has_key?(:'ids')
+        if (value = attributes[:'ids']).is_a?(Array)
+          self.ids = value
+        end
+      end
+
       if attributes.has_key?(:'all')
         self.all = attributes[:'all']
       end
@@ -74,6 +85,7 @@ module SibApiV3Sdk
       return true if self.equal?(o)
       self.class == o.class &&
           emails == o.emails &&
+          ids == o.ids &&
           all == o.all
     end
 
@@ -86,7 +98,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [emails, all].hash
+      [emails, ids, all].hash
     end
 
     # Builds the object from hash

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

@@ -22,7 +22,7 @@ module SibApiV3Sdk
 
     attr_accessor :custom_contact_filter
 
-    # Webhook that will be called once the export process is finished
+    # Webhook that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479
     attr_accessor :notify_url
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -23,7 +23,7 @@ module SibApiV3Sdk
     # Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7].
     attr_accessor :list_ids
 
-    # URL that will be called once the export process is finished
+    # URL that will be called once the import process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479
     attr_accessor :notify_url
 
     attr_accessor :new_list

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

@@ -14,7 +14,7 @@ require 'date'
 
 module SibApiV3Sdk
   class RequestSmsRecipientExport
-    # URL that will be called once the export process is finished
+    # URL that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479
     attr_accessor :notify_url
 
     # Filter the recipients based on how they interacted with the campaign

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

@@ -13,56 +13,18 @@ Swagger Codegen version: 2.4.12
 require 'date'
 
 module SibApiV3Sdk
-  # Email sending credentials including subject, body, to, cc etc.
+  # Custom attributes for the report email.
   class SendReportEmail
-    # Subject of the email message
-    attr_accessor :subject
-
     # Email addresses of the recipients
     attr_accessor :to
 
-    # Type of the message body
-    attr_accessor :content_type
-
-    # Email addresses of the recipients in bcc
-    attr_accessor :bcc
-
-    # Email addresses of the recipients in cc
-    attr_accessor :cc
-
-    # Body of the email message
+    # Custom text message to be presented in the report email.
     attr_accessor :body
 
-    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
       {
-        :'subject' => :'subject',
         :'to' => :'to',
-        :'content_type' => :'contentType',
-        :'bcc' => :'bcc',
-        :'cc' => :'cc',
         :'body' => :'body'
       }
     end
@@ -70,11 +32,7 @@ module SibApiV3Sdk
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'subject' => :'String',
         :'to' => :'Array<String>',
-        :'content_type' => :'String',
-        :'bcc' => :'Array<String>',
-        :'cc' => :'Array<String>',
         :'body' => :'String'
       }
     end
@@ -87,34 +45,12 @@ module SibApiV3Sdk
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.has_key?(:'subject')
-        self.subject = attributes[:'subject']
-      end
-
       if attributes.has_key?(:'to')
         if (value = attributes[:'to']).is_a?(Array)
           self.to = value
         end
       end
 
-      if attributes.has_key?(:'contentType')
-        self.content_type = attributes[:'contentType']
-      else
-        self.content_type = 'html'
-      end
-
-      if attributes.has_key?(:'bcc')
-        if (value = attributes[:'bcc']).is_a?(Array)
-          self.bcc = value
-        end
-      end
-
-      if attributes.has_key?(:'cc')
-        if (value = attributes[:'cc']).is_a?(Array)
-          self.cc = value
-        end
-      end
-
       if attributes.has_key?(:'body')
         self.body = attributes[:'body']
       end
@@ -124,10 +60,6 @@ module SibApiV3Sdk
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @subject.nil?
-        invalid_properties.push('invalid value for "subject", subject cannot be nil.')
-      end
-
       if @to.nil?
         invalid_properties.push('invalid value for "to", to cannot be nil.')
       end
@@ -142,34 +74,17 @@ module SibApiV3Sdk
     # 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 @subject.nil?
       return false if @to.nil?
-      content_type_validator = EnumAttributeValidator.new('String', ['text', 'html'])
-      return false unless content_type_validator.valid?(@content_type)
       return false if @body.nil?
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] content_type Object to be assigned
-    def content_type=(content_type)
-      validator = EnumAttributeValidator.new('String', ['text', 'html'])
-      unless validator.valid?(content_type)
-        fail ArgumentError, 'invalid value for "content_type", must be one of #{validator.allowable_values}.'
-      end
-      @content_type = content_type
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          subject == o.subject &&
           to == o.to &&
-          content_type == o.content_type &&
-          bcc == o.bcc &&
-          cc == o.cc &&
           body == o.body
     end
 
@@ -182,7 +97,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [subject, to, content_type, bcc, cc, body].hash
+      [to, body].hash
     end
 
     # Builds the object from hash

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

@@ -36,7 +36,7 @@ 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, 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 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 )
     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\"}`.

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

@@ -13,7 +13,7 @@ Swagger Codegen version: 2.4.12
 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 or id of sender from which emails will be sent. `name` will be ignored if passed along with sender `id`. For example, {\"name\":\"Mary from MyShop\", \"email\":\"no-reply@myshop.com\"} or {\"id\":2}
   class SendSmtpEmailSender
     # Name of the sender from which the emails will be sent. Maximum allowed characters are 70.
     attr_accessor :name
@@ -21,11 +21,15 @@ module SibApiV3Sdk
     # Email of the sender from which the emails will be sent
     attr_accessor :email
 
+    # Id of the sender from which the emails will be sent
+    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
 
@@ -33,7 +37,8 @@ module SibApiV3Sdk
     def self.swagger_types
       {
         :'name' => :'String',
-        :'email' => :'String'
+        :'email' => :'String',
+        :'id' => :'Integer'
       }
     end
 
@@ -52,6 +57,10 @@ module SibApiV3Sdk
       if attributes.has_key?(:'email')
         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?
@@ -78,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
@@ -90,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