Merge pull request #26 from sendinblue/feature_updated_swagger_sync

Swagger updates for sms api

Author: aakanksha-sib

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 SendinBlue
+Copyright (c) 2019 SendinBlue
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.

docs/CreateWebhook.md

@@ -5,7 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **url** | **String** | URL of the webhook | 
 **description** | **String** | Description of the webhook | [optional] 
-**events** | **Array<String>** | 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 | [optional] 
+**events** | **Array<String>** | 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 | 
 **type** | **String** | Type of the webhook | [optional] [default to "transactional"]
 
 

docs/GetSmsEventReportEvents.md

@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **phone_number** | **String** | Phone number which has generated the event | 
-**date** | **Date** | Date on which the event has been generated | 
+**date** | **DateTime** | UTC date-time on which the event has been generated | 
 **message_id** | **String** | Message ID which generated the event | 
 **event** | **String** | Event which occurred | 
 **reason** | **String** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional] 

docs/RequestContactImport.md

@@ -11,5 +11,6 @@ Name | Type | Description | Notes
 **email_blacklist** | **BOOLEAN** | To blacklist all the contacts for email | [optional] [default to false]
 **sms_blacklist** | **BOOLEAN** | To blacklist all the contacts for sms | [optional] [default to false]
 **update_existing_contacts** | **BOOLEAN** | To facilitate the choice to update the existing contacts | [optional] [default to true]
+**empty_contacts_attributes** | **BOOLEAN** | To facilitate the choice to erase any attribute of the existing contacts with empty value. emptyContactsAttributes = true means the empty fields in your import will erase any attribute that currently contain data in SendinBlue, & emptyContactsAttributes = false means the empty fields will not affect your existing data ( only available if `updateExistingContacts` set to true ) | [optional] [default to false]
 
 

docs/RequestSMSRecipientExport.md

@@ -4,6 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **notify_url** | **String** | URL that will be called once the export process is finished | [optional] 
-**recipients_type** | **String** | Filter the recipients based on how they interacted with the campaign | [default to "all"]
+**recipients_type** | **String** | Filter the recipients based on how they interacted with the campaign | 
 
 

docs/SMSCampaignsApi.md

@@ -401,7 +401,7 @@ nil (empty response body)
 
 
 # **send_test_sms**
-> send_test_sms(campaign_id, send_test_sms)
+> send_test_sms(campaign_id, phone_number)
 
 Send an SMS
 
@@ -421,12 +421,12 @@ api_instance = SibApiV3Sdk::SMSCampaignsApi.new
 
 campaign_id = 789 # Integer | Id of the SMS campaign
 
-send_test_sms = SibApiV3Sdk::SendTestSms.new # SendTestSms | Mobile number to which send the test
+phone_number = SibApiV3Sdk::SendTestSms.new # SendTestSms | Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted
 
 
 begin
   #Send an SMS
-  api_instance.send_test_sms(campaign_id, send_test_sms)
+  api_instance.send_test_sms(campaign_id, phone_number)
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling SMSCampaignsApi->send_test_sms: #{e}"
 end
@@ -437,7 +437,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **campaign_id** | **Integer**| Id of the SMS campaign | 
- **send_test_sms** | [**SendTestSms**](SendTestSms.md)| Mobile number to which send the test | 
+ **phone_number** | [**SendTestSms**](SendTestSms.md)| Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted | 
 
 ### Return type
 

docs/SendReportEmail.md

@@ -3,11 +3,11 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**subject** | **String** | Subject of the email message | [optional] 
-**to** | **Array<String>** | Email addresses of the recipients | [optional] 
-**content_type** | **String** | Type of the message body | [optional] 
+**subject** | **String** | Subject of the email message | 
+**to** | **Array<String>** | Email addresses of the recipients | 
+**content_type** | **String** | Type of the message body | [optional] [default to "html"]
 **bcc** | **Array<String>** | Email addresses of the recipients in bcc | [optional] 
 **cc** | **Array<String>** | Email addresses of the recipients in cc | [optional] 
-**body** | **String** | Body of the email message | [optional] 
+**body** | **String** | Body of the email message | 
 
 

docs/SendSms.md

@@ -5,5 +5,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **reference** | **String** |  | 
 **message_id** | **Integer** |  | 
+**sms_count** | **Integer** | Count of SMS's to send multiple text messages | [optional] 
+**used_credits** | **Float** | SMS credits used per text message | [optional] 
+**remaining_credits** | **Float** | Remaining SMS credits of the user | [optional] 
 
 

docs/SendSmtpEmail.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **text_content** | **String** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional] 
 **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] 
+**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, eps and odt ( 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. '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'}. It's considered only if template is in New Template Language format. | [optional] 

docs/SendTestSms.md

@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**phone_numbers** | **Array<String>** | Mobile number with the country code to send test SMS. The mobile number defined here must belong to one of your contacts in SendinBlue account and must not be blacklisted | [optional] 
+**phone_number** | **String** | Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted | [optional]