Swagger updates for additional parameters in email campaigns

Author: aakanksha-sib

docs/CreateEmailCampaign.md

@@ -6,12 +6,13 @@ Name | Type | Description | Notes
 **tag** | **String** | Tag of the campaign | [optional] 
 **sender** | [**CreateEmailCampaignSender**](CreateEmailCampaignSender.md) |  | 
 **name** | **String** | Name of the campaign | 
-**html_content** | **String** | Mandatory if htmlUrl is empty. Body of the message (HTML) | [optional] 
-**html_url** | **String** | Mandatory if htmlContent is empty. Url to the message (HTML) | [optional] 
+**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] 
 **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, e.g. if you want to include the first name and last name of your recipient, use {FNAME} {LNAME}. These attributes must already exist in your contact database | [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]
@@ -21,5 +22,6 @@ Name | Type | Description | Notes
 **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' | [optional] 
 
 

docs/CreateSmtpTemplate.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **html_url** | **String** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional] 
 **subject** | **String** | Subject of the template | 
 **reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional] 
-**to_field** | **String** | This is to personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. To use the contact attributes here, these must already exist in SendinBlue account | [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] 
 **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] 
 **is_active** | **BOOLEAN** | Status of template. isActive = true means template is active and isActive = false means template is inactive | [optional] 
 

docs/UpdateEmailCampaign.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **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] 
 **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** | This is to personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. To use the contact attributes here, these must already exist in SendinBlue account | [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** | [**UpdateEmailCampaignRecipients**](UpdateEmailCampaignRecipients.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** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts. | [optional] [default to false]
@@ -20,5 +20,6 @@ Name | Type | Description | Notes
 **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'}. | [optional] 
 
 

docs/UpdateSmtpTemplate.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **html_url** | **String** | Required if htmlContent is empty. URL to the body of the email (HTML) | [optional] 
 **subject** | **String** | Subject of the email | [optional] 
 **reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional] 
-**to_field** | **String** | To personalize the «To» Field, e.g. if you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These attributes must already exist in contacts database | [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] 
 **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] 
 **is_active** | **BOOLEAN** | Status of the template. isActive = false means template is inactive, isActive = true means template is active | [optional] 
 

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

@@ -23,12 +23,15 @@ class CreateEmailCampaign
     # Name of the campaign
     attr_accessor :name
 
-    # Mandatory if htmlUrl is empty. Body of the message (HTML)
+    # Mandatory if htmlUrl and templateId are empty. Body of the message (HTML)
     attr_accessor :html_content
 
-    # Mandatory if htmlContent is empty. Url to the message (HTML)
+    # Mandatory if htmlContent and templateId are empty. Url to the message (HTML)
     attr_accessor :html_url
 
+    # 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.
     attr_accessor :scheduled_at
 
@@ -38,7 +41,7 @@ class CreateEmailCampaign
     # Email on which the campaign recipients will be able to reply to
     attr_accessor :reply_to
 
-    # To personalize the «To» Field, e.g. if you want to include the first name and last name of your recipient, use {FNAME} {LNAME}. These attributes must already exist in your contact database
+    # 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
     attr_accessor :to_field
 
     attr_accessor :recipients
@@ -67,6 +70,9 @@ class CreateEmailCampaign
     # Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed
     attr_accessor :utm_campaign
 
+    # Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic'
+    attr_accessor :params
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -97,6 +103,7 @@ def self.attribute_map
         :'name' => :'name',
         :'html_content' => :'htmlContent',
         :'html_url' => :'htmlUrl',
+        :'template_id' => :'templateId',
         :'scheduled_at' => :'scheduledAt',
         :'subject' => :'subject',
         :'reply_to' => :'replyTo',
@@ -109,7 +116,8 @@ def self.attribute_map
         :'type' => :'type',
         :'footer' => :'footer',
         :'header' => :'header',
-        :'utm_campaign' => :'utmCampaign'
+        :'utm_campaign' => :'utmCampaign',
+        :'params' => :'params'
       }
     end
 
@@ -121,6 +129,7 @@ def self.swagger_types
         :'name' => :'String',
         :'html_content' => :'String',
         :'html_url' => :'String',
+        :'template_id' => :'Integer',
         :'scheduled_at' => :'DateTime',
         :'subject' => :'String',
         :'reply_to' => :'String',
@@ -133,7 +142,8 @@ def self.swagger_types
         :'type' => :'String',
         :'footer' => :'String',
         :'header' => :'String',
-        :'utm_campaign' => :'String'
+        :'utm_campaign' => :'String',
+        :'params' => :'Object'
       }
     end
 
@@ -165,6 +175,10 @@ def initialize(attributes = {})
         self.html_url = attributes[:'htmlUrl']
       end
 
+      if attributes.has_key?(:'templateId')
+        self.template_id = attributes[:'templateId']
+      end
+
       if attributes.has_key?(:'scheduledAt')
         self.scheduled_at = attributes[:'scheduledAt']
       end
@@ -221,6 +235,10 @@ def initialize(attributes = {})
         self.utm_campaign = attributes[:'utmCampaign']
       end
 
+      if attributes.has_key?(:'params')
+        self.params = attributes[:'params']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -278,6 +296,7 @@ def ==(o)
           name == o.name &&
           html_content == o.html_content &&
           html_url == o.html_url &&
+          template_id == o.template_id &&
           scheduled_at == o.scheduled_at &&
           subject == o.subject &&
           reply_to == o.reply_to &&
@@ -290,7 +309,8 @@ def ==(o)
           type == o.type &&
           footer == o.footer &&
           header == o.header &&
-          utm_campaign == o.utm_campaign
+          utm_campaign == o.utm_campaign &&
+          params == o.params
     end
 
     # @see the `==` method
@@ -302,7 +322,7 @@ def eql?(o)
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [tag, sender, name, html_content, html_url, scheduled_at, subject, reply_to, to_field, recipients, attachment_url, inline_image_activation, mirror_active, recurring, type, footer, header, utm_campaign].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
     end
 
     # Builds the object from hash

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

@@ -35,7 +35,7 @@ class CreateSmtpTemplate
     # Email on which campaign recipients will be able to reply to
     attr_accessor :reply_to
 
-    # This is to personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. To use the contact attributes here, these must already exist in SendinBlue account
+    # 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
     attr_accessor :to_field
 
     # 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

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

@@ -38,7 +38,7 @@ class UpdateEmailCampaign
     # Email on which campaign recipients will be able to reply to
     attr_accessor :reply_to
 
-    # This is to personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. To use the contact attributes here, these must already exist in SendinBlue account
+    # 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
     attr_accessor :to_field
 
     attr_accessor :recipients
@@ -64,6 +64,9 @@ class UpdateEmailCampaign
     # Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed
     attr_accessor :utm_campaign
 
+    # Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}.
+    attr_accessor :params
+
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -84,7 +87,8 @@ def self.attribute_map
         :'recurring' => :'recurring',
         :'footer' => :'footer',
         :'header' => :'header',
-        :'utm_campaign' => :'utmCampaign'
+        :'utm_campaign' => :'utmCampaign',
+        :'params' => :'params'
       }
     end
 
@@ -107,7 +111,8 @@ def self.swagger_types
         :'recurring' => :'BOOLEAN',
         :'footer' => :'String',
         :'header' => :'String',
-        :'utm_campaign' => :'String'
+        :'utm_campaign' => :'String',
+        :'params' => :'Object'
       }
     end
 
@@ -191,6 +196,10 @@ def initialize(attributes = {})
         self.utm_campaign = attributes[:'utmCampaign']
       end
 
+      if attributes.has_key?(:'params')
+        self.params = attributes[:'params']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -227,7 +236,8 @@ def ==(o)
           recurring == o.recurring &&
           footer == o.footer &&
           header == o.header &&
-          utm_campaign == o.utm_campaign
+          utm_campaign == o.utm_campaign &&
+          params == o.params
     end
 
     # @see the `==` method
@@ -239,7 +249,7 @@ def eql?(o)
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [tag, sender, name, html_content, html_url, scheduled_at, subject, reply_to, to_field, recipients, attachment_url, inline_image_activation, mirror_active, recurring, footer, header, utm_campaign].hash
+      [tag, sender, name, html_content, html_url, scheduled_at, subject, reply_to, to_field, recipients, attachment_url, inline_image_activation, mirror_active, recurring, footer, header, utm_campaign, params].hash
     end
 
     # Builds the object from hash

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

@@ -35,7 +35,7 @@ class UpdateSmtpTemplate
     # Email on which campaign recipients will be able to reply to
     attr_accessor :reply_to
 
-    # To personalize the «To» Field, e.g. if you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These attributes must already exist in contacts database
+    # 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
     attr_accessor :to_field
 
     # 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

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

@@ -11,5 +11,5 @@
 =end
 
 module SibApiV3Sdk
-  VERSION = "5.1.0"
+  VERSION = "5.1.1"
 end

spec/models/create_email_campaign_spec.rb

@@ -62,6 +62,12 @@
     end
   end
 
+  describe 'test attribute "template_id"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "scheduled_at"' do
     it 'should work' do
        # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -144,5 +150,11 @@
     end
   end
 
+  describe 'test attribute "params"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end