sib-api-v3-sdk 5.4.0 → 5.5.0

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

@@ -212,7 +212,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Send the SMS campaign to a mobile number
+    # Send SMS message to a mobile number
     # @param send_transac_sms Values to send a transactional SMS
     # @param [Hash] opts the optional parameters
     # @return [SendSms]
@@ -221,7 +221,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Send the SMS campaign to a mobile number
+    # Send SMS message to a mobile number
     # @param send_transac_sms Values to send a transactional SMS
     # @param [Hash] opts the optional parameters
     # @return [Array<(SendSms, Fixnum, Hash)>] SendSms data, response status code and response headers

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

@@ -29,6 +29,31 @@ module SibApiV3Sdk
     # Password for the child account to login
     attr_accessor :password
 
+    # Language of the child account
+    attr_accessor :language
+
+    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
       {
@@ -36,7 +61,8 @@ module SibApiV3Sdk
         :'first_name' => :'firstName',
         :'last_name' => :'lastName',
         :'company_name' => :'companyName',
-        :'password' => :'password'
+        :'password' => :'password',
+        :'language' => :'language'
       }
     end
 
@@ -47,7 +73,8 @@ module SibApiV3Sdk
         :'first_name' => :'String',
         :'last_name' => :'String',
         :'company_name' => :'String',
-        :'password' => :'String'
+        :'password' => :'String',
+        :'language' => :'String'
       }
     end
 
@@ -78,6 +105,10 @@ module SibApiV3Sdk
       if attributes.has_key?(:'password')
         self.password = attributes[:'password']
       end
+
+      if attributes.has_key?(:'language')
+        self.language = attributes[:'language']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -115,9 +146,21 @@ module SibApiV3Sdk
       return false if @last_name.nil?
       return false if @company_name.nil?
       return false if @password.nil?
+      language_validator = EnumAttributeValidator.new('String', ['fr', 'es', 'pt', 'it', 'de', 'en'])
+      return false unless language_validator.valid?(@language)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] language Object to be assigned
+    def language=(language)
+      validator = EnumAttributeValidator.new('String', ['fr', 'es', 'pt', 'it', 'de', 'en'])
+      unless validator.valid?(language)
+        fail ArgumentError, 'invalid value for "language", must be one of #{validator.allowable_values}.'
+      end
+      @language = language
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -127,7 +170,8 @@ module SibApiV3Sdk
           first_name == o.first_name &&
           last_name == o.last_name &&
           company_name == o.company_name &&
-          password == o.password
+          password == o.password &&
+          language == o.language
     end
 
     # @see the `==` method
@@ -139,7 +183,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [email, first_name, last_name, company_name, password].hash
+      [email, first_name, last_name, company_name, password, language].hash
     end
 
     # Builds the object from hash

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

@@ -26,10 +26,10 @@ module SibApiV3Sdk
     # Lists under user account where contact should not be added
     attr_accessor :exclude_list_ids
 
-    # Id of the DOI template
+    # Id of the Double opt-in (DOI) template
     attr_accessor :template_id
 
-    # URL of the web page that user will be redirected to after clicking on the double opt in URL.
+    # URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}.
     attr_accessor :redirection_url
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -17,17 +17,22 @@ module SibApiV3Sdk
     # AuthKey of Reseller child created
     attr_accessor :auth_key
 
+    # Id of Reseller child created
+    attr_accessor :id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'auth_key' => :'authKey'
+        :'auth_key' => :'authKey',
+        :'id' => :'id'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'auth_key' => :'String'
+        :'auth_key' => :'String',
+        :'id' => :'Integer'
       }
     end
 
@@ -42,6 +47,10 @@ module SibApiV3Sdk
       if attributes.has_key?(:'authKey')
         self.auth_key = attributes[:'authKey']
       end
+
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -67,7 +76,8 @@ module SibApiV3Sdk
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          auth_key == o.auth_key
+          auth_key == o.auth_key &&
+          id == o.id
     end
 
     # @see the `==` method
@@ -79,7 +89,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [auth_key].hash
+      [auth_key, id].hash
     end
 
     # Builds the object from hash

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

@@ -17,7 +17,7 @@ module SibApiV3Sdk
     # From Name to use for the sender
     attr_accessor :name
 
-    # From Email to use for the sender
+    # From email to use for the sender. A verification email will be sent to this address.
     attr_accessor :email
 
     # Mandatory in case of dedicated IP, IPs to associate to the sender

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

@@ -20,7 +20,7 @@ module SibApiV3Sdk
     # Description of the webhook
     attr_accessor :description
 
-    # Events triggering the webhook. Possible values for Transactional type webhook – request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed and possible values for Marketing type webhook – spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition & delivered
+    # Events triggering the webhook. Possible values for Transactional type webhook – sent, request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed and possible values for Marketing type webhook – spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition & delivered
     attr_accessor :events
 
     # Type of the webhook

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

@@ -14,7 +14,7 @@ require 'date'
 
 module SibApiV3Sdk
   class EmailExportRecipients
-    # Webhook called once the export process is finished
+    # Webhook called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479
     attr_accessor :notify_url
 
     # Type of recipients to export for a campaign

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,7 +17,7 @@ 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
+    # Required if 'emails' is empty. 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.

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_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/update_child_account_status.rb

@@ -23,12 +23,16 @@ module SibApiV3Sdk
     # Status of Marketing Automation Platform activation for your account (true=enabled, false=disabled)
     attr_accessor :marketing_automation
 
+    # Status of SMS Campaign Platform activation for your account (true=enabled, false=disabled)
+    attr_accessor :sms_campaign
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'transactional_email' => :'transactionalEmail',
         :'transactional_sms' => :'transactionalSms',
-        :'marketing_automation' => :'marketingAutomation'
+        :'marketing_automation' => :'marketingAutomation',
+        :'sms_campaign' => :'smsCampaign'
       }
     end
 
@@ -37,7 +41,8 @@ module SibApiV3Sdk
       {
         :'transactional_email' => :'BOOLEAN',
         :'transactional_sms' => :'BOOLEAN',
-        :'marketing_automation' => :'BOOLEAN'
+        :'marketing_automation' => :'BOOLEAN',
+        :'sms_campaign' => :'BOOLEAN'
       }
     end
 
@@ -60,6 +65,10 @@ module SibApiV3Sdk
       if attributes.has_key?(:'marketingAutomation')
         self.marketing_automation = attributes[:'marketingAutomation']
       end
+
+      if attributes.has_key?(:'smsCampaign')
+        self.sms_campaign = attributes[:'smsCampaign']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -82,7 +91,8 @@ module SibApiV3Sdk
       self.class == o.class &&
           transactional_email == o.transactional_email &&
           transactional_sms == o.transactional_sms &&
-          marketing_automation == o.marketing_automation
+          marketing_automation == o.marketing_automation &&
+          sms_campaign == o.sms_campaign
     end
 
     # @see the `==` method
@@ -94,7 +104,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [transactional_email, transactional_sms, marketing_automation].hash
+      [transactional_email, transactional_sms, marketing_automation, sms_campaign].hash
     end
 
     # Builds the object from hash

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

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.12
 =end
 
 module SibApiV3Sdk
-  VERSION = "5.4.0"
+  VERSION = "5.5.0"
 end

data/spec/api/contacts_api_spec.rb

@@ -69,8 +69,8 @@ describe 'ContactsApi' do
   end
 
   # unit tests for create_doi_contact
-  # Create a contact to trigger the DOI workflow from a Landing Page form
-  # @param create_doi_contact Values to create the DOI contact
+  # Create Contact via DOI (Double-Opt-In) Flow
+  # @param create_doi_contact Values to create the Double opt-in (DOI) contact
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'create_doi_contact test' do