sib-api-v3-sdk 4.0.1 → 5.0.0

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

@@ -34,6 +34,7 @@ module SibApiV3Sdk
 
     attr_accessor :list_unsubscribed
 
+    # Set of attributes of the contact
     attr_accessor :attributes
 
 
@@ -61,7 +62,7 @@ module SibApiV3Sdk
         :'modified_at' => :'DateTime',
         :'list_ids' => :'Array<Integer>',
         :'list_unsubscribed' => :'Array<Integer>',
-        :'attributes' => :'Hash<String, String>'
+        :'attributes' => :'Object'
       }
     end
 
@@ -106,9 +107,7 @@ module SibApiV3Sdk
       end
 
       if attributes.has_key?(:'attributes')
-        if (value = attributes[:'attributes']).is_a?(Hash)
-          self.attributes = value
-        end
+        self.attributes = attributes[:'attributes']
       end
 
     end

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

@@ -15,6 +15,10 @@ require 'date'
 module SibApiV3Sdk
 
   class GetExtendedCampaignStats
+    # Overall statistics of the campaign
+    attr_accessor :global_stats
+
+    # List-wise statistics of the campaign.
     attr_accessor :campaign_stats
 
     # Number of clicks on mirror link
@@ -23,6 +27,7 @@ module SibApiV3Sdk
     # Number of remaning emails to send
     attr_accessor :remaining
 
+    # Statistics about the number of clicks for the links
     attr_accessor :links_stats
 
     attr_accessor :stats_by_domain
@@ -31,6 +36,7 @@ module SibApiV3Sdk
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'global_stats' => :'globalStats',
         :'campaign_stats' => :'campaignStats',
         :'mirror_click' => :'mirrorClick',
         :'remaining' => :'remaining',
@@ -42,10 +48,11 @@ module SibApiV3Sdk
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'global_stats' => :'Object',
         :'campaign_stats' => :'Array<Object>',
         :'mirror_click' => :'Integer',
         :'remaining' => :'Integer',
-        :'links_stats' => :'Hash<String, GetExtendedCampaignStatsLinksStats>',
+        :'links_stats' => :'Object',
         :'stats_by_domain' => :'GetStatsByDomain'
       }
     end
@@ -58,6 +65,10 @@ 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?(:'globalStats')
+        self.global_stats = attributes[:'globalStats']
+      end
+
       if attributes.has_key?(:'campaignStats')
         if (value = attributes[:'campaignStats']).is_a?(Array)
           self.campaign_stats = value
@@ -73,9 +84,7 @@ module SibApiV3Sdk
       end
 
       if attributes.has_key?(:'linksStats')
-        if (value = attributes[:'linksStats']).is_a?(Hash)
-          self.links_stats = value
-        end
+        self.links_stats = attributes[:'linksStats']
       end
 
       if attributes.has_key?(:'statsByDomain')
@@ -88,6 +97,10 @@ module SibApiV3Sdk
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @global_stats.nil?
+        invalid_properties.push("invalid value for 'global_stats', global_stats cannot be nil.")
+      end
+
       if @campaign_stats.nil?
         invalid_properties.push("invalid value for 'campaign_stats', campaign_stats cannot be nil.")
       end
@@ -114,6 +127,7 @@ 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 @global_stats.nil?
       return false if @campaign_stats.nil?
       return false if @mirror_click.nil?
       return false if @remaining.nil?
@@ -127,6 +141,7 @@ module SibApiV3Sdk
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          global_stats == o.global_stats &&
           campaign_stats == o.campaign_stats &&
           mirror_click == o.mirror_click &&
           remaining == o.remaining &&
@@ -143,7 +158,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [campaign_stats, mirror_click, remaining, links_stats, stats_by_domain].hash
+      [global_stats, campaign_stats, mirror_click, remaining, links_stats, stats_by_domain].hash
     end
 
     # Builds the object from hash

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

@@ -34,6 +34,7 @@ module SibApiV3Sdk
 
     attr_accessor :list_unsubscribed
 
+    # Set of attributes of the contact
     attr_accessor :attributes
 
     attr_accessor :statistics
@@ -64,7 +65,7 @@ module SibApiV3Sdk
         :'modified_at' => :'DateTime',
         :'list_ids' => :'Array<Integer>',
         :'list_unsubscribed' => :'Array<Integer>',
-        :'attributes' => :'Hash<String, String>',
+        :'attributes' => :'Object',
         :'statistics' => :'GetExtendedContactDetailsStatistics'
       }
     end
@@ -110,9 +111,7 @@ module SibApiV3Sdk
       end
 
       if attributes.has_key?(:'attributes')
-        if (value = attributes[:'attributes']).is_a?(Hash)
-          self.attributes = value
-        end
+        self.attributes = attributes[:'attributes']
       end
 
       if attributes.has_key?(:'statistics')

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

@@ -15,10 +15,10 @@ require 'date'
 module SibApiV3Sdk
 
   class RequestContactExport
-    # Name of attributes to export. These attributes must be in your contact database
+    # 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
 
-    # Filter to apply to the export
+    # 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/request_contact_import.rb

@@ -15,13 +15,13 @@ require 'date'
 module SibApiV3Sdk
 
   class RequestContactImport
-    # Mandatory if fileBody not defined. URL of the file to be imported (no local file). Possible file types: .txt, .csv
+    # Mandatory if fileBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv
     attr_accessor :file_url
 
     # Mandatory if fileUrl is not defined. CSV content to be imported. Use semicolon to separate multiple attributes
     attr_accessor :file_body
 
-    # Manadatory if newList is not defined. Ids of the lists in which to add the contacts
+    # 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
@@ -29,6 +29,15 @@ module SibApiV3Sdk
 
     attr_accessor :new_list
 
+    # To blacklist all the contacts for email
+    attr_accessor :email_blacklist
+
+    # To blacklist all the contacts for sms
+    attr_accessor :sms_blacklist
+
+    # To facilitate the choice to update the existing contacts
+    attr_accessor :update_existing_contacts
+
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -37,7 +46,10 @@ module SibApiV3Sdk
         :'file_body' => :'fileBody',
         :'list_ids' => :'listIds',
         :'notify_url' => :'notifyUrl',
-        :'new_list' => :'newList'
+        :'new_list' => :'newList',
+        :'email_blacklist' => :'emailBlacklist',
+        :'sms_blacklist' => :'smsBlacklist',
+        :'update_existing_contacts' => :'updateExistingContacts'
       }
     end
 
@@ -48,7 +60,10 @@ module SibApiV3Sdk
         :'file_body' => :'String',
         :'list_ids' => :'Array<Integer>',
         :'notify_url' => :'String',
-        :'new_list' => :'RequestContactImportNewList'
+        :'new_list' => :'RequestContactImportNewList',
+        :'email_blacklist' => :'BOOLEAN',
+        :'sms_blacklist' => :'BOOLEAN',
+        :'update_existing_contacts' => :'BOOLEAN'
       }
     end
 
@@ -82,6 +97,24 @@ module SibApiV3Sdk
         self.new_list = attributes[:'newList']
       end
 
+      if attributes.has_key?(:'emailBlacklist')
+        self.email_blacklist = attributes[:'emailBlacklist']
+      else
+        self.email_blacklist = false
+      end
+
+      if attributes.has_key?(:'smsBlacklist')
+        self.sms_blacklist = attributes[:'smsBlacklist']
+      else
+        self.sms_blacklist = false
+      end
+
+      if attributes.has_key?(:'updateExistingContacts')
+        self.update_existing_contacts = attributes[:'updateExistingContacts']
+      else
+        self.update_existing_contacts = true
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -106,7 +139,10 @@ module SibApiV3Sdk
           file_body == o.file_body &&
           list_ids == o.list_ids &&
           notify_url == o.notify_url &&
-          new_list == o.new_list
+          new_list == o.new_list &&
+          email_blacklist == o.email_blacklist &&
+          sms_blacklist == o.sms_blacklist &&
+          update_existing_contacts == o.update_existing_contacts
     end
 
     # @see the `==` method
@@ -118,7 +154,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [file_url, file_body, list_ids, notify_url, new_list].hash
+      [file_url, file_body, list_ids, notify_url, new_list, email_blacklist, sms_blacklist, update_existing_contacts].hash
     end
 
     # Builds the object from hash

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

@@ -13,12 +13,12 @@ Swagger Codegen version: 2.3.1
 require 'date'
 
 module SibApiV3Sdk
-
+  # To create a new list and import the contacts into it, pass the listName and an optional folderId.
   class RequestContactImportNewList
     # List with listName will be created first and users will be imported in it (Mandatory if listIds is empty).
     attr_accessor :list_name
 
-    # Folder id will be used with listName to make newly created list’s desired parent (Mandatory if listName is not empty).
+    # Id of the folder where this new list shall be created (Mandatory if listName is not empty).
     attr_accessor :folder_id
 
 

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

@@ -15,28 +15,33 @@ require 'date'
 module SibApiV3Sdk
 
   class SendEmail
-    # Email addresses of the recipients
+    # List of the email addresses of the recipients. For example, ['abc@example.com', 'asd@example.com'].
     attr_accessor :email_to
 
-    # Email addresses of the recipients in bcc
+    # List of the email addresses of the recipients in bcc
     attr_accessor :email_bcc
 
-    # Email addresses of the recipients in cc
+    # List of the email addresses of the recipients in cc
     attr_accessor :email_cc
 
-    # Email on which campaign recipients will be able to reply to
+    # Email address which shall be used by campaign recipients to reply back
     attr_accessor :reply_to
 
     # 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 base64 content of the attachment. 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
+    # 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. 'X-Mailin-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', 'X-Mailin-IP':'1.2.3.4'}
     attr_accessor :headers
 
+    # 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
+    attr_accessor :tags
+
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -48,7 +53,8 @@ module SibApiV3Sdk
         :'attachment_url' => :'attachmentUrl',
         :'attachment' => :'attachment',
         :'headers' => :'headers',
-        :'attributes' => :'attributes'
+        :'attributes' => :'attributes',
+        :'tags' => :'tags'
       }
     end
 
@@ -61,8 +67,9 @@ module SibApiV3Sdk
         :'reply_to' => :'String',
         :'attachment_url' => :'String',
         :'attachment' => :'Array<SendEmailAttachment>',
-        :'headers' => :'Hash<String, String>',
-        :'attributes' => :'Hash<String, String>'
+        :'headers' => :'Object',
+        :'attributes' => :'Object',
+        :'tags' => :'Array<String>'
       }
     end
 
@@ -107,14 +114,16 @@ module SibApiV3Sdk
       end
 
       if attributes.has_key?(:'headers')
-        if (value = attributes[:'headers']).is_a?(Hash)
-          self.headers = value
-        end
+        self.headers = attributes[:'headers']
       end
 
       if attributes.has_key?(:'attributes')
-        if (value = attributes[:'attributes']).is_a?(Hash)
-          self.attributes = value
+        self.attributes = attributes[:'attributes']
+      end
+
+      if attributes.has_key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
         end
       end
 
@@ -150,7 +159,8 @@ module SibApiV3Sdk
           attachment_url == o.attachment_url &&
           attachment == o.attachment &&
           headers == o.headers &&
-          attributes == o.attributes
+          attributes == o.attributes &&
+          tags == o.tags
     end
 
     # @see the `==` method
@@ -162,7 +172,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [email_to, email_bcc, email_cc, reply_to, attachment_url, attachment, headers, attributes].hash
+      [email_to, email_bcc, email_cc, reply_to, attachment_url, attachment, headers, attributes, tags].hash
     end
 
     # Builds the object from hash

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

@@ -60,25 +60,38 @@ module SibApiV3Sdk
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if !@content.nil? && @content !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+      if @content.nil?
+        invalid_properties.push("invalid value for 'content', content cannot be nil.")
+      end
+
+      if @content !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
         invalid_properties.push("invalid value for 'content', must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/.")
       end
 
+      if @name.nil?
+        invalid_properties.push("invalid value for 'name', name cannot be nil.")
+      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 !@content.nil? && @content !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+      return false if @content.nil?
+      return false if @content !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+      return false if @name.nil?
       return true
     end
 
     # Custom attribute writer method with validation
     # @param [Object] content Value to be assigned
     def content=(content)
+      if content.nil?
+        fail ArgumentError, "content cannot be nil"
+      end
 
-      if !content.nil? && content !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+      if content !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
         fail ArgumentError, "invalid value for 'content', must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/."
       end
 

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

@@ -13,7 +13,7 @@ Swagger Codegen version: 2.3.1
 require 'date'
 
 module SibApiV3Sdk
-
+  # Email sending credentials including subject, body, to, cc etc.
   class SendReportEmail
     # Subject of the email message
     attr_accessor :subject

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

@@ -17,13 +17,13 @@ module SibApiV3Sdk
   class SendSmtpEmail
     attr_accessor :sender
 
-    # Email addresses and names of the recipients
+    # 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
 
-    # Email addresses and names of the recipients in bcc
+    # List of email addresses and names (optional) of the recipients in bcc
     attr_accessor :bcc
 
-    # Email addresses and names of the recipients in cc
+    # List of email addresses and names (optional) of the recipients in cc
     attr_accessor :cc
 
     # HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed )
@@ -37,16 +37,21 @@ module SibApiV3Sdk
 
     attr_accessor :reply_to
 
-    # Pass the absolute URL (no local file) or the base64 content of the attachment. Name can be used in both cases to define the attachment name. It is mandatory in case of content. 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 ( 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 and eps ( Ignored if 'templateId' is passed )
     attr_accessor :attachment
 
+    # Pass the set of headers that shall be sent along the mail headers in the original email. 'X-Mailin-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', 'X-Mailin-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'}.
     attr_accessor :params
 
+    # Tag your emails to find them more easily
+    attr_accessor :tags
+
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -62,7 +67,8 @@ module SibApiV3Sdk
         :'attachment' => :'attachment',
         :'headers' => :'headers',
         :'template_id' => :'templateId',
-        :'params' => :'params'
+        :'params' => :'params',
+        :'tags' => :'tags'
       }
     end
 
@@ -78,9 +84,10 @@ module SibApiV3Sdk
         :'subject' => :'String',
         :'reply_to' => :'SendSmtpEmailReplyTo',
         :'attachment' => :'Array<SendSmtpEmailAttachment>',
-        :'headers' => :'Hash<String, String>',
+        :'headers' => :'Object',
         :'template_id' => :'Integer',
-        :'params' => :'Hash<String, String>'
+        :'params' => :'Object',
+        :'tags' => :'Array<String>'
       }
     end
 
@@ -137,9 +144,7 @@ module SibApiV3Sdk
       end
 
       if attributes.has_key?(:'headers')
-        if (value = attributes[:'headers']).is_a?(Hash)
-          self.headers = value
-        end
+        self.headers = attributes[:'headers']
       end
 
       if attributes.has_key?(:'templateId')
@@ -147,8 +152,12 @@ module SibApiV3Sdk
       end
 
       if attributes.has_key?(:'params')
-        if (value = attributes[:'params']).is_a?(Hash)
-          self.params = value
+        self.params = attributes[:'params']
+      end
+
+      if attributes.has_key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
         end
       end
 
@@ -188,7 +197,8 @@ module SibApiV3Sdk
           attachment == o.attachment &&
           headers == o.headers &&
           template_id == o.template_id &&
-          params == o.params
+          params == o.params &&
+          tags == o.tags
     end
 
     # @see the `==` method
@@ -200,7 +210,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].hash
+      [sender, to, bcc, cc, html_content, text_content, subject, reply_to, attachment, headers, template_id, params, tags].hash
     end
 
     # Builds the object from hash