Skip to content

Commit 7c3f9c0

Browse files
Merge pull request #13 from sendinblue/feature_updated_swagger_sync
swagger sync: updates related to contacts api and some other parameters
2 parents d0d13b5 + 4cb83d3 commit 7c3f9c0

File tree

364 files changed

+729
-1208
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

364 files changed

+729
-1208
lines changed

.swagger-codegen/VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2.2.3
1+
2.3.1

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -110,15 +110,15 @@ Class | Method | HTTP request | Description
110110
*SibApiV3Sdk::ContactsApi* | [**update_folder**](docs/ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a contact folder
111111
*SibApiV3Sdk::ContactsApi* | [**update_list**](docs/ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
112112
*SibApiV3Sdk::EmailCampaignsApi* | [**create_email_campaign**](docs/EmailCampaignsApi.md#create_email_campaign) | **POST** /emailCampaigns | Create an email campaign
113-
*SibApiV3Sdk::EmailCampaignsApi* | [**delete_email_campaigns**](docs/EmailCampaignsApi.md#delete_email_campaigns) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
113+
*SibApiV3Sdk::EmailCampaignsApi* | [**delete_email_campaign**](docs/EmailCampaignsApi.md#delete_email_campaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
114114
*SibApiV3Sdk::EmailCampaignsApi* | [**email_export_recipients**](docs/EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of a campaign
115115
*SibApiV3Sdk::EmailCampaignsApi* | [**get_email_campaign**](docs/EmailCampaignsApi.md#get_email_campaign) | **GET** /emailCampaigns/{campaignId} | Get campaign informations
116116
*SibApiV3Sdk::EmailCampaignsApi* | [**get_email_campaigns**](docs/EmailCampaignsApi.md#get_email_campaigns) | **GET** /emailCampaigns | Return all your created campaigns
117117
*SibApiV3Sdk::EmailCampaignsApi* | [**send_email_campaign_now**](docs/EmailCampaignsApi.md#send_email_campaign_now) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign id of the campaign immediately
118118
*SibApiV3Sdk::EmailCampaignsApi* | [**send_report**](docs/EmailCampaignsApi.md#send_report) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaigns
119119
*SibApiV3Sdk::EmailCampaignsApi* | [**send_test_email**](docs/EmailCampaignsApi.md#send_test_email) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
120120
*SibApiV3Sdk::EmailCampaignsApi* | [**update_campaign_status**](docs/EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update a campaign status
121-
*SibApiV3Sdk::EmailCampaignsApi* | [**update_email_campaigns**](docs/EmailCampaignsApi.md#update_email_campaigns) | **PUT** /emailCampaigns/{campaignId} | Update a campaign
121+
*SibApiV3Sdk::EmailCampaignsApi* | [**update_email_campaign**](docs/EmailCampaignsApi.md#update_email_campaign) | **PUT** /emailCampaigns/{campaignId} | Update a campaign
122122
*SibApiV3Sdk::FoldersApi* | [**create_folder**](docs/FoldersApi.md#create_folder) | **POST** /contacts/folders | Create a folder
123123
*SibApiV3Sdk::FoldersApi* | [**delete_folder**](docs/FoldersApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
124124
*SibApiV3Sdk::FoldersApi* | [**get_folder**](docs/FoldersApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns folder details
@@ -146,7 +146,7 @@ Class | Method | HTTP request | Description
146146
*SibApiV3Sdk::ResellerApi* | [**remove_credits**](docs/ResellerApi.md#remove_credits) | **POST** /reseller/children/{childId}/credits/remove | Remove Email and/or SMS credits from a specific child account
147147
*SibApiV3Sdk::ResellerApi* | [**update_reseller_child**](docs/ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childId} | Updates infos of reseller's child based on the childId supplied
148148
*SibApiV3Sdk::SMSCampaignsApi* | [**create_sms_campaign**](docs/SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign
149-
*SibApiV3Sdk::SMSCampaignsApi* | [**delete_sms_campaigns**](docs/SMSCampaignsApi.md#delete_sms_campaigns) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign
149+
*SibApiV3Sdk::SMSCampaignsApi* | [**delete_sms_campaign**](docs/SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign
150150
*SibApiV3Sdk::SMSCampaignsApi* | [**get_sms_campaign**](docs/SMSCampaignsApi.md#get_sms_campaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
151151
*SibApiV3Sdk::SMSCampaignsApi* | [**get_sms_campaigns**](docs/SMSCampaignsApi.md#get_sms_campaigns) | **GET** /smsCampaigns | Returns the informations for all your created SMS campaigns
152152
*SibApiV3Sdk::SMSCampaignsApi* | [**request_sms_recipient_export**](docs/SMSCampaignsApi.md#request_sms_recipient_export) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Exports the recipients of the specified campaign.
@@ -221,8 +221,6 @@ Class | Method | HTTP request | Description
221221
- [SibApiV3Sdk::GetAttributesEnumeration](docs/GetAttributesEnumeration.md)
222222
- [SibApiV3Sdk::GetCampaignOverview](docs/GetCampaignOverview.md)
223223
- [SibApiV3Sdk::GetCampaignRecipients](docs/GetCampaignRecipients.md)
224-
- [SibApiV3Sdk::GetCampaignRecipientsExclusionLists](docs/GetCampaignRecipientsExclusionLists.md)
225-
- [SibApiV3Sdk::GetCampaignRecipientsLists](docs/GetCampaignRecipientsLists.md)
226224
- [SibApiV3Sdk::GetCampaignStats](docs/GetCampaignStats.md)
227225
- [SibApiV3Sdk::GetChildInfoApiKeys](docs/GetChildInfoApiKeys.md)
228226
- [SibApiV3Sdk::GetChildInfoCredits](docs/GetChildInfoCredits.md)
@@ -295,7 +293,7 @@ Class | Method | HTTP request | Description
295293
- [SibApiV3Sdk::RequestContactExport](docs/RequestContactExport.md)
296294
- [SibApiV3Sdk::RequestContactImport](docs/RequestContactImport.md)
297295
- [SibApiV3Sdk::RequestContactImportNewList](docs/RequestContactImportNewList.md)
298-
- [SibApiV3Sdk::RequestSMSRecipientExport](docs/RequestSMSRecipientExport.md)
296+
- [SibApiV3Sdk::RequestSmsRecipientExport](docs/RequestSmsRecipientExport.md)
299297
- [SibApiV3Sdk::SendEmail](docs/SendEmail.md)
300298
- [SibApiV3Sdk::SendEmailAttachment](docs/SendEmailAttachment.md)
301299
- [SibApiV3Sdk::SendReport](docs/SendReport.md)

docs/ContactsApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -627,7 +627,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
627627
opts = {
628628
limit: 50, # Integer | Number of documents per page
629629
offset: 0, # Integer | Index of the first document of the page
630-
modified_since: DateTime.parse("2013-10-20T19:20:30+01:00") # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
630+
modified_since: DateTime.parse("2013-10-20T19:20:30+01:00") # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
631631
}
632632

633633
begin
@@ -645,7 +645,7 @@ Name | Type | Description | Notes
645645
------------- | ------------- | ------------- | -------------
646646
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
647647
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
648-
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
648+
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
649649

650650
### Return type
651651

@@ -684,7 +684,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
684684
list_id = 789 # Integer | Id of the list
685685

686686
opts = {
687-
modified_since: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
687+
modified_since: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
688688
limit: 50, # Integer | Number of documents per page
689689
offset: 0 # Integer | Index of the first document of the page
690690
}
@@ -703,7 +703,7 @@ end
703703
Name | Type | Description | Notes
704704
------------- | ------------- | ------------- | -------------
705705
**list_id** | **Integer**| Id of the list |
706-
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
706+
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
707707
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
708708
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
709709

docs/CreateContact.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,6 @@ Name | Type | Description | Notes
99
**sms_blacklisted** | **BOOLEAN** | Blacklist the contact for SMS (smsBlacklisted = true) | [optional]
1010
**list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional]
1111
**update_enabled** | **BOOLEAN** | Facilitate to update existing contact in same request (updateEnabled = true) | [optional] [default to false]
12+
**smtp_blacklist_sender** | **Array<String>** | SMTP forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | [optional]
1213

1314

docs/CreateEmailCampaign.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**tag** | **String** | Tag of the campaign | [optional]
7-
**sender** | [**CreateEmailCampaignSender**](CreateEmailCampaignSender.md) | | [optional]
7+
**sender** | [**CreateEmailCampaignSender**](CreateEmailCampaignSender.md) | |
88
**name** | **String** | Name of the campaign |
99
**html_content** | **String** | Mandatory if htmlUrl is empty. Body of the message (HTML) | [optional]
1010
**html_url** | **String** | Mandatory if htmlContent is empty. Url to the message (HTML) | [optional]
11-
**scheduled_at** | **DateTime** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
11+
**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]
1212
**subject** | **String** | Subject of the campaign |
1313
**reply_to** | **String** | Email on which the campaign recipients will be able to reply to | [optional]
14-
**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]
14+
**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]
1515
**recipients** | [**CreateEmailCampaignRecipients**](CreateEmailCampaignRecipients.md) | | [optional]
16-
**attachment_url** | **String** | Absolute url of the attachment (no local file). Extensions allowed xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff and rtf | [optional]
16+
**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]
1717
**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]
1818
**mirror_active** | **BOOLEAN** | Use true to enable the mirror link | [optional]
1919
**recurring** | **BOOLEAN** | For trigger campagins use false to make sure a contact receives the same campaign only once | [optional] [default to false]

docs/CreateSmsCampaign.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ Name | Type | Description | Notes
77
**sender** | **String** | Name of the sender. The number of characters is limited to 11 |
88
**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]
99
**recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional]
10-
**scheduled_at** | **DateTime** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
10+
**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]
1111

1212

docs/CreateSmtpTemplate.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**tag** | **String** | Tag of the template | [optional]
7-
**sender** | [**CreateSmtpTemplateSender**](CreateSmtpTemplateSender.md) | | [optional]
7+
**sender** | [**CreateSmtpTemplateSender**](CreateSmtpTemplateSender.md) | |
88
**template_name** | **String** | Name of the template |
99
**html_content** | **String** | Body of the message (HTML version). The field must have more than 10 characters. REQUIRED if htmlUrl is empty | [optional]
1010
**html_url** | **String** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional]
1111
**subject** | **String** | Subject of the template |
1212
**reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional]
13-
**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]
14-
**attachment_url** | **String** | Absolute url of the attachment (no local file). Extensions allowed xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff and rtf | [optional]
13+
**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]
14+
**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]
1515
**is_active** | **BOOLEAN** | Status of template. isActive = true means template is active and isActive = false means template is inactive | [optional]
1616

1717

docs/EmailCampaignsApi.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ All URIs are relative to *https://api.sendinblue.com/v3*
55
Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**create_email_campaign**](EmailCampaignsApi.md#create_email_campaign) | **POST** /emailCampaigns | Create an email campaign
8-
[**delete_email_campaigns**](EmailCampaignsApi.md#delete_email_campaigns) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
8+
[**delete_email_campaign**](EmailCampaignsApi.md#delete_email_campaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
99
[**email_export_recipients**](EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of a campaign
1010
[**get_email_campaign**](EmailCampaignsApi.md#get_email_campaign) | **GET** /emailCampaigns/{campaignId} | Get campaign informations
1111
[**get_email_campaigns**](EmailCampaignsApi.md#get_email_campaigns) | **GET** /emailCampaigns | Return all your created campaigns
1212
[**send_email_campaign_now**](EmailCampaignsApi.md#send_email_campaign_now) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign id of the campaign immediately
1313
[**send_report**](EmailCampaignsApi.md#send_report) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaigns
1414
[**send_test_email**](EmailCampaignsApi.md#send_test_email) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
1515
[**update_campaign_status**](EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update a campaign status
16-
[**update_email_campaigns**](EmailCampaignsApi.md#update_email_campaigns) | **PUT** /emailCampaigns/{campaignId} | Update a campaign
16+
[**update_email_campaign**](EmailCampaignsApi.md#update_email_campaign) | **PUT** /emailCampaigns/{campaignId} | Update a campaign
1717

1818

1919
# **create_email_campaign**
@@ -68,8 +68,8 @@ Name | Type | Description | Notes
6868

6969

7070

71-
# **delete_email_campaigns**
72-
> delete_email_campaigns(campaign_id)
71+
# **delete_email_campaign**
72+
> delete_email_campaign(campaign_id)
7373
7474
Delete an email campaign
7575

@@ -92,9 +92,9 @@ campaign_id = 789 # Integer | id of the campaign
9292

9393
begin
9494
#Delete an email campaign
95-
api_instance.delete_email_campaigns(campaign_id)
95+
api_instance.delete_email_campaign(campaign_id)
9696
rescue SibApiV3Sdk::ApiError => e
97-
puts "Exception when calling EmailCampaignsApi->delete_email_campaigns: #{e}"
97+
puts "Exception when calling EmailCampaignsApi->delete_email_campaign: #{e}"
9898
end
9999
```
100100

@@ -501,8 +501,8 @@ nil (empty response body)
501501

502502

503503

504-
# **update_email_campaigns**
505-
> update_email_campaigns(campaign_id, email_campaign)
504+
# **update_email_campaign**
505+
> update_email_campaign(campaign_id, email_campaign)
506506
507507
Update a campaign
508508

@@ -527,9 +527,9 @@ email_campaign = SibApiV3Sdk::UpdateEmailCampaign.new # UpdateEmailCampaign | Va
527527

528528
begin
529529
#Update a campaign
530-
api_instance.update_email_campaigns(campaign_id, email_campaign)
530+
api_instance.update_email_campaign(campaign_id, email_campaign)
531531
rescue SibApiV3Sdk::ApiError => e
532-
puts "Exception when calling EmailCampaignsApi->update_email_campaigns: #{e}"
532+
puts "Exception when calling EmailCampaignsApi->update_email_campaign: #{e}"
533533
end
534534
```
535535

docs/GetAccount.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Name | Type | Description | Notes
77
**first_name** | **String** | First Name |
88
**last_name** | **String** | Last Name |
99
**company_name** | **String** | Name of the company |
10-
**address** | [**GetExtendedClientAddress**](GetExtendedClientAddress.md) | | [optional]
10+
**address** | [**GetExtendedClientAddress**](GetExtendedClientAddress.md) | |
1111
**plan** | [**Array<GetAccountPlan>**](GetAccountPlan.md) | Information about your plans and credits |
12-
**relay** | [**GetAccountRelay**](GetAccountRelay.md) | | [optional]
12+
**relay** | [**GetAccountRelay**](GetAccountRelay.md) | |
1313
**marketing_automation** | [**GetAccountMarketingAutomation**](GetAccountMarketingAutomation.md) | | [optional]
1414

1515

docs/GetAccountRelay.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**enabled** | **BOOLEAN** | Status of your SMTP Account (true=Enabled, false=Disabled) |
7-
**data** | [**GetAccountRelayData**](GetAccountRelayData.md) | | [optional]
7+
**data** | [**GetAccountRelayData**](GetAccountRelayData.md) | |
88

99

docs/GetCampaignRecipients.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**lists** | [**Array<GetCampaignRecipientsLists>**](GetCampaignRecipientsLists.md) | Lists included in the campaign |
7-
**exclusion_lists** | [**Array<GetCampaignRecipientsExclusionLists>**](GetCampaignRecipientsExclusionLists.md) | Lists excluded of the campaign |
6+
**lists** | **Array<Integer>** | |
7+
**exclusion_lists** | **Array<Integer>** | |
88

99

docs/GetCampaignRecipientsExclusionLists.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/GetCampaignRecipientsLists.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

0 commit comments

Comments
 (0)