Skip to content

Commit 40edcc3

Browse files
aakanksha-sibaakanksha-sib
authored
Merge pull request #15 from sendinblue/feature_updated_swagger_sync
Type object fix in get sms/email campaigns call
2 parents 4112c8d + 24b39c3 commit 40edcc3

Some content is hidden

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

56 files changed

+1218
-381
lines changed

‎README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Class | Method | HTTP request | Description
103103
*SibApiV3Sdk::ContactsApi* | [**get_list**](docs/ContactsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get the details of a list
104104
*SibApiV3Sdk::ContactsApi* | [**get_lists**](docs/ContactsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
105105
*SibApiV3Sdk::ContactsApi* | [**import_contacts**](docs/ContactsApi.md#import_contacts) | **POST** /contacts/import | Import contacts
106-
*SibApiV3Sdk::ContactsApi* | [**remove_contact_to_list**](docs/ContactsApi.md#remove_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
106+
*SibApiV3Sdk::ContactsApi* | [**remove_contact_from_list**](docs/ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
107107
*SibApiV3Sdk::ContactsApi* | [**request_contact_export**](docs/ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
108108
*SibApiV3Sdk::ContactsApi* | [**update_attribute**](docs/ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
109109
*SibApiV3Sdk::ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Updates a contact
@@ -132,19 +132,19 @@ Class | Method | HTTP request | Description
132132
*SibApiV3Sdk::ListsApi* | [**get_folder_lists**](docs/ListsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder
133133
*SibApiV3Sdk::ListsApi* | [**get_list**](docs/ListsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get the details of a list
134134
*SibApiV3Sdk::ListsApi* | [**get_lists**](docs/ListsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
135-
*SibApiV3Sdk::ListsApi* | [**remove_contact_to_list**](docs/ListsApi.md#remove_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
135+
*SibApiV3Sdk::ListsApi* | [**remove_contact_from_list**](docs/ListsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
136136
*SibApiV3Sdk::ListsApi* | [**update_list**](docs/ListsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
137137
*SibApiV3Sdk::ProcessApi* | [**get_process**](docs/ProcessApi.md#get_process) | **GET** /processes/{processId} | Return the informations for a process
138138
*SibApiV3Sdk::ProcessApi* | [**get_processes**](docs/ProcessApi.md#get_processes) | **GET** /processes | Return all the processes for your account
139-
*SibApiV3Sdk::ResellerApi* | [**add_credits**](docs/ResellerApi.md#add_credits) | **POST** /reseller/children/{childId}/credits/add | Add Email and/or SMS credits to a specific child account
140-
*SibApiV3Sdk::ResellerApi* | [**associate_ip_to_child**](docs/ResellerApi.md#associate_ip_to_child) | **POST** /reseller/children/{childId}/ips/associate | Associate a dedicated IP to the child
139+
*SibApiV3Sdk::ResellerApi* | [**add_credits**](docs/ResellerApi.md#add_credits) | **POST** /reseller/children/{childAuthKey}/credits/add | Add Email and/or SMS credits to a specific child account
140+
*SibApiV3Sdk::ResellerApi* | [**associate_ip_to_child**](docs/ResellerApi.md#associate_ip_to_child) | **POST** /reseller/children/{childAuthKey}/ips/associate | Associate a dedicated IP to the child
141141
*SibApiV3Sdk::ResellerApi* | [**create_reseller_child**](docs/ResellerApi.md#create_reseller_child) | **POST** /reseller/children | Creates a reseller child
142-
*SibApiV3Sdk::ResellerApi* | [**delete_reseller_child**](docs/ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childId} | Deletes a single reseller child based on the childId supplied
143-
*SibApiV3Sdk::ResellerApi* | [**dissociate_ip_from_child**](docs/ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childId}/ips/dissociate | Dissociate a dedicated IP to the child
144-
*SibApiV3Sdk::ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childId} | Gets the info about a specific child account
142+
*SibApiV3Sdk::ResellerApi* | [**delete_reseller_child**](docs/ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childAuthKey} | Deletes a single reseller child based on the childAuthKey supplied
143+
*SibApiV3Sdk::ResellerApi* | [**dissociate_ip_from_child**](docs/ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childAuthKey}/ips/dissociate | Dissociate a dedicated IP to the child
144+
*SibApiV3Sdk::ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | Gets the info about a specific child account
145145
*SibApiV3Sdk::ResellerApi* | [**get_reseller_childs**](docs/ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Gets the list of all reseller's children accounts
146-
*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
147-
*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
146+
*SibApiV3Sdk::ResellerApi* | [**remove_credits**](docs/ResellerApi.md#remove_credits) | **POST** /reseller/children/{childAuthKey}/credits/remove | Remove Email and/or SMS credits from a specific child account
147+
*SibApiV3Sdk::ResellerApi* | [**update_reseller_child**](docs/ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childAuthKey} | Updates infos of reseller's child based on the childAuthKey supplied
148148
*SibApiV3Sdk::SMSCampaignsApi* | [**create_sms_campaign**](docs/SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign
149149
*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
@@ -186,8 +186,8 @@ Class | Method | HTTP request | Description
186186

187187
## Documentation for Models
188188

189+
- [SibApiV3Sdk::AddContactToList](docs/AddContactToList.md)
189190
- [SibApiV3Sdk::AddCredits](docs/AddCredits.md)
190-
- [SibApiV3Sdk::AddRemoveContactToList](docs/AddRemoveContactToList.md)
191191
- [SibApiV3Sdk::CreateAttribute](docs/CreateAttribute.md)
192192
- [SibApiV3Sdk::CreateAttributeEnumeration](docs/CreateAttributeEnumeration.md)
193193
- [SibApiV3Sdk::CreateChild](docs/CreateChild.md)
@@ -197,6 +197,7 @@ Class | Method | HTTP request | Description
197197
- [SibApiV3Sdk::CreateEmailCampaignSender](docs/CreateEmailCampaignSender.md)
198198
- [SibApiV3Sdk::CreateList](docs/CreateList.md)
199199
- [SibApiV3Sdk::CreateModel](docs/CreateModel.md)
200+
- [SibApiV3Sdk::CreateReseller](docs/CreateReseller.md)
200201
- [SibApiV3Sdk::CreateSender](docs/CreateSender.md)
201202
- [SibApiV3Sdk::CreateSenderIps](docs/CreateSenderIps.md)
202203
- [SibApiV3Sdk::CreateSenderModel](docs/CreateSenderModel.md)
@@ -223,8 +224,9 @@ Class | Method | HTTP request | Description
223224
- [SibApiV3Sdk::GetCampaignRecipients](docs/GetCampaignRecipients.md)
224225
- [SibApiV3Sdk::GetCampaignStats](docs/GetCampaignStats.md)
225226
- [SibApiV3Sdk::GetChildInfoApiKeys](docs/GetChildInfoApiKeys.md)
227+
- [SibApiV3Sdk::GetChildInfoApiKeysV2](docs/GetChildInfoApiKeysV2.md)
228+
- [SibApiV3Sdk::GetChildInfoApiKeysV3](docs/GetChildInfoApiKeysV3.md)
226229
- [SibApiV3Sdk::GetChildInfoCredits](docs/GetChildInfoCredits.md)
227-
- [SibApiV3Sdk::GetChildInfoIps](docs/GetChildInfoIps.md)
228230
- [SibApiV3Sdk::GetChildInfoStatistics](docs/GetChildInfoStatistics.md)
229231
- [SibApiV3Sdk::GetChildrenList](docs/GetChildrenList.md)
230232
- [SibApiV3Sdk::GetClient](docs/GetClient.md)
@@ -289,6 +291,7 @@ Class | Method | HTTP request | Description
289291
- [SibApiV3Sdk::RemainingCreditModel](docs/RemainingCreditModel.md)
290292
- [SibApiV3Sdk::RemainingCreditModelChild](docs/RemainingCreditModelChild.md)
291293
- [SibApiV3Sdk::RemainingCreditModelReseller](docs/RemainingCreditModelReseller.md)
294+
- [SibApiV3Sdk::RemoveContactFromList](docs/RemoveContactFromList.md)
292295
- [SibApiV3Sdk::RemoveCredits](docs/RemoveCredits.md)
293296
- [SibApiV3Sdk::RequestContactExport](docs/RequestContactExport.md)
294297
- [SibApiV3Sdk::RequestContactImport](docs/RequestContactImport.md)

‎docs/AddContactToList.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# SibApiV3Sdk::AddContactToList
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**emails** | **Array<String>** | Emails to add to a list | [optional]
7+
8+

‎docs/AddCredits.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-
**sms** | **Integer** | SMS credits to be added to the child account | [optional]
7-
**email** | **Integer** | Email credits to be added to the child account | [optional]
6+
**sms** | **Integer** | Required if email credits are empty. SMS credits to be added to the child account | [optional]
7+
**email** | **Integer** | Required if sms credits are empty. Email credits to be added to the child account | [optional]
88

99

‎docs/AddRemoveContactToList.md

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

‎docs/ContactsApi.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Method | HTTP request | Description
2323
[**get_list**](ContactsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get the details of a list
2424
[**get_lists**](ContactsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
2525
[**import_contacts**](ContactsApi.md#import_contacts) | **POST** /contacts/import | Import contacts
26-
[**remove_contact_to_list**](ContactsApi.md#remove_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
26+
[**remove_contact_from_list**](ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
2727
[**request_contact_export**](ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
2828
[**update_attribute**](ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
2929
[**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Updates a contact
@@ -52,7 +52,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
5252

5353
list_id = 789 # Integer | Id of the list
5454

55-
contact_emails = SibApiV3Sdk::AddRemoveContactToList.new # AddRemoveContactToList | Emails addresses of the contacts
55+
contact_emails = SibApiV3Sdk::AddContactToList.new # AddContactToList | Emails addresses of the contacts
5656

5757

5858
begin
@@ -69,7 +69,7 @@ end
6969
Name | Type | Description | Notes
7070
------------- | ------------- | ------------- | -------------
7171
**list_id** | **Integer**| Id of the list |
72-
**contact_emails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails addresses of the contacts |
72+
**contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses of the contacts |
7373

7474
### Return type
7575

@@ -1048,8 +1048,8 @@ Name | Type | Description | Notes
10481048

10491049

10501050

1051-
# **remove_contact_to_list**
1052-
> PostContactInfo remove_contact_to_list(list_id, contact_emails)
1051+
# **remove_contact_from_list**
1052+
> PostContactInfo remove_contact_from_list(list_id, contact_emails)
10531053
10541054
Remove existing contacts from a list
10551055

@@ -1069,15 +1069,15 @@ api_instance = SibApiV3Sdk::ContactsApi.new
10691069

10701070
list_id = 789 # Integer | Id of the list
10711071

1072-
contact_emails = SibApiV3Sdk::AddRemoveContactToList.new # AddRemoveContactToList | Emails adresses of the contact
1072+
contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails adresses of the contact
10731073

10741074

10751075
begin
10761076
#Remove existing contacts from a list
1077-
result = api_instance.remove_contact_to_list(list_id, contact_emails)
1077+
result = api_instance.remove_contact_from_list(list_id, contact_emails)
10781078
p result
10791079
rescue SibApiV3Sdk::ApiError => e
1080-
puts "Exception when calling ContactsApi->remove_contact_to_list: #{e}"
1080+
puts "Exception when calling ContactsApi->remove_contact_from_list: #{e}"
10811081
end
10821082
```
10831083

@@ -1086,7 +1086,7 @@ end
10861086
Name | Type | Description | Notes
10871087
------------- | ------------- | ------------- | -------------
10881088
**list_id** | **Integer**| Id of the list |
1089-
**contact_emails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails adresses of the contact |
1089+
**contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails adresses of the contact |
10901090

10911091
### Return type
10921092

‎docs/CreateReseller.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# SibApiV3Sdk::CreateReseller
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**auth_key** | **String** | AuthKey of Reseller child created |
7+
8+

‎docs/GetChildInfo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
1010
**credits** | [**GetChildInfoCredits**](GetChildInfoCredits.md) | | [optional]
1111
**statistics** | [**GetChildInfoStatistics**](GetChildInfoStatistics.md) | | [optional]
1212
**password** | **String** | The encrypted password of child account |
13-
**ips** | [**Array<GetChildInfoIps>**](GetChildInfoIps.md) | IP(s) associated to a child account user | [optional]
14-
**api_keys** | [**Array<GetChildInfoApiKeys>**](GetChildInfoApiKeys.md) | API Keys associated to child account | [optional]
13+
**ips** | **Array<String>** | IP(s) associated to a child account user | [optional]
14+
**api_keys** | [**GetChildInfoApiKeys**](GetChildInfoApiKeys.md) | | [optional]
1515

1616

‎docs/GetChildInfoApiKeys.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**name** | **String** | Name of the key |
7-
**key** | **String** | API Key |
8-
**secret** | **String** | Secret Key associated to the API Key (in case v1 Key is used only) | [optional]
6+
**v2** | [**Array<GetChildInfoApiKeysV2>**](GetChildInfoApiKeysV2.md) | |
7+
**v3** | [**Array<GetChildInfoApiKeysV3>**](GetChildInfoApiKeysV3.md) | | [optional]
98

109

‎docs/GetChildInfoApiKeysV2.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# SibApiV3Sdk::GetChildInfoApiKeysV2
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **String** | Name of the key for version 2 |
7+
**key** | **String** | API Key for version 2 |
8+
9+

‎docs/GetChildInfoApiKeysV3.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# SibApiV3Sdk::GetChildInfoApiKeysV3
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **String** | Name of the key for version 3 |
7+
**key** | **String** | API Key for version 3 |
8+
9+

0 commit comments

Comments
 (0)