Merge pull request #25 from sendinblue/feature_updated_swagger_sync

Swagger updates for sms campaigns

Author: aakanksha-sib

docs/CreateEmailCampaign.md

@@ -22,6 +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] 
+**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] 
 
 

docs/CreateSmsCampaign.md

@@ -5,7 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Name of the campaign | 
 **sender** | **String** | Name of the sender. The number of characters is limited to 11 | 
-**content** | **String** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS | [optional] 
+**content** | **String** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS | 
 **recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) |  | [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] 
 

docs/CreateSmsCampaignRecipients.md

@@ -4,6 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **list_ids** | **Array<Integer>** | Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty | 
-**exclusion_list_ids** | **Array<Integer>** | List ids which have to be excluded from a campaign | 
+**exclusion_list_ids** | **Array<Integer>** | List ids which have to be excluded from a campaign | [optional] 
 
 

docs/GetAggregatedReport.md

@@ -15,5 +15,6 @@ Name | Type | Description | Notes
 **spam_reports** | **Integer** | Number of complaint (spam report) for the timeframe | 
 **blocked** | **Integer** | Number of blocked contact emails for the timeframe | 
 **invalid** | **Integer** | Number of invalid emails for the timeframe | 
+**unsubscribed** | **Integer** | Number of unsubscribed emails for the timeframe | 
 
 

docs/GetReportsReports.md

@@ -15,5 +15,6 @@ Name | Type | Description | Notes
 **spam_reports** | **Integer** | Number of complaints (spam reports) for the date | 
 **blocked** | **Integer** | Number of blocked emails for the date | 
 **invalid** | **Integer** | Number of invalid emails for the date | 
+**unsubscribed** | **Integer** | Number of unsubscribed emails for the date | 
 
 

docs/GetSmsCampaign.md

@@ -8,7 +8,6 @@ Name | Type | Description | Notes
 **status** | **String** | Status of the SMS Campaign | 
 **content** | **String** | Content of the SMS Campaign | 
 **scheduled_at** | **DateTime** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | 
-**test_sent** | **BOOLEAN** | Retrieved the status of test SMS sending. (true=Test SMS has been sent  false=Test SMS has not been sent) | 
 **sender** | **String** | Sender of the SMS Campaign | 
 **created_at** | **DateTime** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
 **modified_at** | **DateTime** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 

docs/GetSmsCampaignOverview.md

@@ -8,7 +8,6 @@ Name | Type | Description | Notes
 **status** | **String** | Status of the SMS Campaign | 
 **content** | **String** | Content of the SMS Campaign | 
 **scheduled_at** | **DateTime** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | 
-**test_sent** | **BOOLEAN** | Retrieved the status of test SMS sending. (true=Test SMS has been sent  false=Test SMS has not been sent) | 
 **sender** | **String** | Sender of the SMS Campaign | 
 **created_at** | **DateTime** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
 **modified_at** | **DateTime** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 

docs/SMSCampaignsApi.md

@@ -195,6 +195,8 @@ api_instance = SibApiV3Sdk::SMSCampaignsApi.new
 
 opts = { 
   status: "status_example", # String | Status of campaign.
+  start_date: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
+  end_date: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
   limit: 500, # Integer | Number limitation for the result returned
   offset: 0 # Integer | Beginning point in the list to retrieve from.
 }
@@ -213,6 +215,8 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **status** | **String**| Status of campaign. | [optional] 
+ **start_date** | **DateTime**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional] 
+ **end_date** | **DateTime**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional] 
  **limit** | **Integer**| Number limitation for the result returned | [optional] [default to 500]
  **offset** | **Integer**| Beginning point in the list to retrieve from. | [optional] [default to 0]
 

docs/SendEmail.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **reply_to** | **String** | Email address which shall be used by campaign recipients to reply back | [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] 
 **attachment** | [**Array<SendEmailAttachment>**](SendEmailAttachment.md) | 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'}]. | [optional] 
-**headers** | **Object** | 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'} | [optional] 
+**headers** | **Object** | Pass the set of 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. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'} | [optional] 
 **attributes** | **Object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'} | [optional] 
 **tags** | **Array<String>** | Tag your emails to find them more easily | [optional] 
 

docs/SendSmtpEmail.md

@@ -12,9 +12,9 @@ Name | Type | Description | Notes
 **subject** | **String** | Subject of the message. Mandatory if 'templateId' is not passed | [optional] 
 **reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) |  | [optional] 
 **attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | 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 ) | [optional] 
-**headers** | **Object** | 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'} | [optional] 
+**headers** | **Object** | Pass the set of 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. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'} | [optional] 
 **template_id** | **Integer** | Id of the template | [optional] 
-**params** | **Object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. | [optional] 
+**params** | **Object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. It's considered only if template is in New Template Language format. | [optional] 
 **tags** | **Array<String>** | Tag your emails to find them more easily | [optional] 
 
 

docs/SendTransacSms.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 **sender** | **String** | Name of the sender. Only alphanumeric characters. No more than 11 characters | 
 **recipient** | **String** | Mobile number to send SMS with the country code | 
 **content** | **String** | Content of the message. If more than 160 characters long, will be sent as multiple text messages | 
-**type** | **String** | Type of the SMS | [optional] [default to "transactional"]
+**type** | **String** | Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. | [optional] [default to "transactional"]
 **tag** | **String** | Tag of the message | [optional] 
 **web_url** | **String** | Webhook to call for each event triggered by the message (delivered etc.) | [optional] 
 

docs/UpdateEmailCampaign.md

@@ -20,6 +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] 
+**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] 
 
 

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

@@ -194,6 +194,8 @@ def get_sms_campaign_with_http_info(campaign_id, get_sms_campaign, opts = {})
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :status Status of campaign.
+    # @option opts [DateTime] :start_date Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
+    # @option opts [DateTime] :end_date Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
     # @option opts [Integer] :limit Number limitation for the result returned (default to 500)
     # @option opts [Integer] :offset Beginning point in the list to retrieve from. (default to 0)
     # @return [GetSmsCampaigns]
@@ -206,15 +208,17 @@ def get_sms_campaigns(opts = {})
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :status Status of campaign.
+    # @option opts [DateTime] :start_date Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
+    # @option opts [DateTime] :end_date Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
     # @option opts [Integer] :limit Number limitation for the result returned
     # @option opts [Integer] :offset Beginning point in the list to retrieve from.
     # @return [Array<(GetSmsCampaigns, Fixnum, Hash)>] GetSmsCampaigns data, response status code and response headers
     def get_sms_campaigns_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: SMSCampaignsApi.get_sms_campaigns ..."
       end
-      if @api_client.config.client_side_validation && opts[:'status'] && !['suspended', 'archived', 'sent', 'queued', 'draft', 'inProcess'].include?(opts[:'status'])
-        fail ArgumentError, 'invalid value for "status", must be one of suspended, archived, sent, queued, draft, inProcess'
+      if @api_client.config.client_side_validation && opts[:'status'] && !['suspended', 'archive', 'sent', 'queued', 'draft', 'inProcess'].include?(opts[:'status'])
+        fail ArgumentError, 'invalid value for "status", must be one of suspended, archive, sent, queued, draft, inProcess'
       end
       if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
         fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SMSCampaignsApi.get_sms_campaigns, must be smaller than or equal to 1000.'
@@ -226,6 +230,8 @@ def get_sms_campaigns_with_http_info(opts = {})
       # query parameters
       query_params = {}
       query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
+      query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
       query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
 

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

@@ -281,8 +281,8 @@ def get_email_event_report_with_http_info(opts = {})
         fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SMTPApi.get_email_event_report, must be smaller than or equal to 100.'
       end
 
-      if @api_client.config.client_side_validation && opts[:'event'] && !['bounces', 'hardBounces', 'softBounces', 'delivered', 'spam', 'requests', 'opened', 'clicks', 'invalid', 'deferred', 'blocked'].include?(opts[:'event'])
-        fail ArgumentError, 'invalid value for "event", must be one of bounces, hardBounces, softBounces, delivered, spam, requests, opened, clicks, invalid, deferred, blocked'
+      if @api_client.config.client_side_validation && opts[:'event'] && !['bounces', 'hardBounces', 'softBounces', 'delivered', 'spam', 'requests', 'opened', 'clicks', 'invalid', 'deferred', 'blocked', 'unsubscribed'].include?(opts[:'event'])
+        fail ArgumentError, 'invalid value for "event", must be one of bounces, hardBounces, softBounces, delivered, spam, requests, opened, clicks, invalid, deferred, blocked, unsubscribed'
       end
       # resource path
       local_var_path = "/smtp/statistics/events"

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

@@ -70,7 +70,7 @@ 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'
+    # 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

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

@@ -98,6 +98,10 @@ def list_invalid_properties
         invalid_properties.push("invalid value for 'sender', the character length must be smaller than or equal to 11.")
       end
 
+      if @content.nil?
+        invalid_properties.push("invalid value for 'content', content cannot be nil.")
+      end
+
       return invalid_properties
     end
 
@@ -107,6 +111,7 @@ def valid?
       return false if @name.nil?
       return false if @sender.nil?
       return false if @sender.to_s.length > 11
+      return false if @content.nil?
       return true
     end
 

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

@@ -68,18 +68,13 @@ def list_invalid_properties
         invalid_properties.push("invalid value for 'list_ids', list_ids cannot be nil.")
       end
 
-      if @exclusion_list_ids.nil?
-        invalid_properties.push("invalid value for 'exclusion_list_ids', exclusion_list_ids 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 @list_ids.nil?
-      return false if @exclusion_list_ids.nil?
       return true
     end