SABT functionality updates and response schema modifications for few api's

Author: aakanksha-sib

README.md

@@ -207,6 +207,7 @@ Class | Method | HTTP request | Description
  - [SibApiV3Sdk::CreateSmtpEmail](docs/CreateSmtpEmail.md)
  - [SibApiV3Sdk::CreateSmtpTemplate](docs/CreateSmtpTemplate.md)
  - [SibApiV3Sdk::CreateSmtpTemplateSender](docs/CreateSmtpTemplateSender.md)
+ - [SibApiV3Sdk::CreateUpdateContactModel](docs/CreateUpdateContactModel.md)
  - [SibApiV3Sdk::CreateUpdateFolder](docs/CreateUpdateFolder.md)
  - [SibApiV3Sdk::CreateWebhook](docs/CreateWebhook.md)
  - [SibApiV3Sdk::CreatedProcessId](docs/CreatedProcessId.md)

docs/ContactsApi.md

@@ -145,7 +145,7 @@ nil (empty response body)
 
 
 # **create_contact**
-> CreateModel create_contact(create_contact)
+> CreateUpdateContactModel create_contact(create_contact)
 
 Create a contact
 
@@ -183,7 +183,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**CreateModel**](CreateModel.md)
+[**CreateUpdateContactModel**](CreateUpdateContactModel.md)
 
 ### Authorization
 

docs/CreateEmailCampaign.md

@@ -9,19 +9,18 @@ Name | Type | Description | Notes
 **html_content** | **String** | Mandatory if htmlUrl and templateId are empty. Body of the message (HTML) | [optional] 
 **html_url** | **String** | Mandatory if htmlContent and templateId are empty. Url to the message (HTML) | [optional] 
 **template_id** | **Integer** | Mandatory if htmlContent and htmlUrl are empty. Id of the SMTP template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. | [optional] 
-**scheduled_at** | **DateTime** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] 
+**scheduled_at** | **DateTime** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional] 
 **subject** | **String** | Subject of the campaign | 
 **reply_to** | **String** | Email on which the campaign recipients will be able to reply to | [optional] 
 **to_field** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] 
 **recipients** | [**CreateEmailCampaignRecipients**](CreateEmailCampaignRecipients.md) |  | [optional] 
 **attachment_url** | **String** | 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 | [optional] 
 **inline_image_activation** | **BOOLEAN** | Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts | [optional] [default to false]
 **mirror_active** | **BOOLEAN** | Use true to enable the mirror link | [optional] 
-**recurring** | **BOOLEAN** | For trigger campagins use false to make sure a contact receives the same campaign only once | [optional] [default to false]
-**type** | **String** | Type of the campaign | 
 **footer** | **String** | Footer of the email campaign | [optional] 
 **header** | **String** | Header of the email campaign | [optional] 
 **utm_campaign** | **String** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional] 
 **params** | **Object** | Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional] 
+**send_at_best_time** | **BOOLEAN** | Set this to true if you want to send your campaign at best time. | [optional] [default to false]
 
 

docs/CreateUpdateContactModel.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::CreateUpdateContactModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the contact when a new contact is created | [optional] 
+
+

docs/PostContactInfoContacts.md

@@ -3,7 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**success** | **Array<String>** |  | 
+**success** | **Array<String>** |  | [optional] 
 **failure** | **Array<String>** |  | [optional] 
+**total** | **Integer** | Displays the count of total number of contacts removed from list when user opts for \"all\" option. | [optional] 
 
 

docs/UpdateEmailCampaign.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **name** | **String** | Name of the campaign | [optional] 
 **html_content** | **String** | Body of the message (HTML version). REQUIRED if htmlUrl is empty | [optional] 
 **html_url** | **String** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional] 
-**scheduled_at** | **DateTime** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] 
+**scheduled_at** | **DateTime** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional] 
 **subject** | **String** | Subject of the campaign | [optional] 
 **reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional] 
 **to_field** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] 
@@ -21,5 +21,6 @@ Name | Type | Description | Notes
 **header** | **String** | Header of the email campaign | [optional] 
 **utm_campaign** | **String** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional] 
 **params** | **Object** | Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional] 
+**send_at_best_time** | **BOOLEAN** | Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled. | [optional] 
 
 

lib/sib-api-v3-sdk.rb

@@ -37,6 +37,7 @@
 require 'sib-api-v3-sdk/models/create_smtp_email'
 require 'sib-api-v3-sdk/models/create_smtp_template'
 require 'sib-api-v3-sdk/models/create_smtp_template_sender'
+require 'sib-api-v3-sdk/models/create_update_contact_model'
 require 'sib-api-v3-sdk/models/create_update_folder'
 require 'sib-api-v3-sdk/models/create_webhook'
 require 'sib-api-v3-sdk/models/created_process_id'

lib/sib-api-v3-sdk/api/contacts_api.rb

@@ -155,7 +155,7 @@ def create_attribute_with_http_info(attribute_category, attribute_name, create_a
     # 
     # @param create_contact Values to create a contact
     # @param [Hash] opts the optional parameters
-    # @return [CreateModel]
+    # @return [CreateUpdateContactModel]
     def create_contact(create_contact, opts = {})
       data, _status_code, _headers = create_contact_with_http_info(create_contact, opts)
       return data
@@ -165,7 +165,7 @@ def create_contact(create_contact, opts = {})
     # 
     # @param create_contact Values to create a contact
     # @param [Hash] opts the optional parameters
-    # @return [Array<(CreateModel, Fixnum, Hash)>] CreateModel data, response status code and response headers
+    # @return [Array<(CreateUpdateContactModel, Fixnum, Hash)>] CreateUpdateContactModel data, response status code and response headers
     def create_contact_with_http_info(create_contact, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: ContactsApi.create_contact ..."
@@ -199,7 +199,7 @@ def create_contact_with_http_info(create_contact, opts = {})
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'CreateModel')
+        :return_type => 'CreateUpdateContactModel')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: ContactsApi#create_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

lib/sib-api-v3-sdk/models/create_email_campaign.rb

@@ -32,7 +32,7 @@ class CreateEmailCampaign
     # Mandatory if htmlContent and htmlUrl are empty. Id of the SMTP template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature.
     attr_accessor :template_id
 
-    # Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
+    # Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part).
     attr_accessor :scheduled_at
 
     # Subject of the campaign
@@ -55,12 +55,6 @@ class CreateEmailCampaign
     # Use true to enable the mirror link
     attr_accessor :mirror_active
 
-    # For trigger campagins use false to make sure a contact receives the same campaign only once
-    attr_accessor :recurring
-
-    # Type of the campaign
-    attr_accessor :type
-
     # Footer of the email campaign
     attr_accessor :footer
 
@@ -73,27 +67,9 @@ class CreateEmailCampaign
     # Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField'
     attr_accessor :params
 
-    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
+    # Set this to true if you want to send your campaign at best time.
+    attr_accessor :send_at_best_time
 
-      def valid?(value)
-        !value || allowable_values.include?(value)
-      end
-    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -112,12 +88,11 @@ def self.attribute_map
         :'attachment_url' => :'attachmentUrl',
         :'inline_image_activation' => :'inlineImageActivation',
         :'mirror_active' => :'mirrorActive',
-        :'recurring' => :'recurring',
-        :'type' => :'type',
         :'footer' => :'footer',
         :'header' => :'header',
         :'utm_campaign' => :'utmCampaign',
-        :'params' => :'params'
+        :'params' => :'params',
+        :'send_at_best_time' => :'sendAtBestTime'
       }
     end
 
@@ -138,12 +113,11 @@ def self.swagger_types
         :'attachment_url' => :'String',
         :'inline_image_activation' => :'BOOLEAN',
         :'mirror_active' => :'BOOLEAN',
-        :'recurring' => :'BOOLEAN',
-        :'type' => :'String',
         :'footer' => :'String',
         :'header' => :'String',
         :'utm_campaign' => :'String',
-        :'params' => :'Object'
+        :'params' => :'Object',
+        :'send_at_best_time' => :'BOOLEAN'
       }
     end
 
@@ -213,16 +187,6 @@ def initialize(attributes = {})
         self.mirror_active = attributes[:'mirrorActive']
       end
 
-      if attributes.has_key?(:'recurring')
-        self.recurring = attributes[:'recurring']
-      else
-        self.recurring = false
-      end
-
-      if attributes.has_key?(:'type')
-        self.type = attributes[:'type']
-      end
-
       if attributes.has_key?(:'footer')
         self.footer = attributes[:'footer']
       end
@@ -239,6 +203,12 @@ def initialize(attributes = {})
         self.params = attributes[:'params']
       end
 
+      if attributes.has_key?(:'sendAtBestTime')
+        self.send_at_best_time = attributes[:'sendAtBestTime']
+      else
+        self.send_at_best_time = false
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -257,10 +227,6 @@ def list_invalid_properties
         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
-
       return invalid_properties
     end
 
@@ -270,22 +236,9 @@ def valid?
       return false if @sender.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)
       return true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] type Object to be assigned
-    def type=(type)
-      validator = EnumAttributeValidator.new('String', ["classic", "trigger"])
-      unless validator.valid?(type)
-        fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
-      end
-      @type = type
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -305,12 +258,11 @@ def ==(o)
           attachment_url == o.attachment_url &&
           inline_image_activation == o.inline_image_activation &&
           mirror_active == o.mirror_active &&
-          recurring == o.recurring &&
-          type == o.type &&
           footer == o.footer &&
           header == o.header &&
           utm_campaign == o.utm_campaign &&
-          params == o.params
+          params == o.params &&
+          send_at_best_time == o.send_at_best_time
     end
 
     # @see the `==` method
@@ -322,7 +274,7 @@ def eql?(o)
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [tag, sender, name, html_content, html_url, template_id, scheduled_at, subject, reply_to, to_field, recipients, attachment_url, inline_image_activation, mirror_active, recurring, type, footer, header, utm_campaign, params].hash
+      [tag, sender, name, html_content, html_url, template_id, scheduled_at, subject, reply_to, to_field, recipients, attachment_url, inline_image_activation, mirror_active, footer, header, utm_campaign, params, send_at_best_time].hash
     end
 
     # Builds the object from hash