Type object fix in get sms/email camapaigns call

sendinblue · Mar 22, 2018 · 24b39c3 · 24b39c3
1 parent 4112c8d
commit 24b39c3
Show file tree

Hide file tree

Showing 56 changed files with 1,218 additions and 381 deletions.
diff --git a/README.md b/README.md
@@ -103,7 +103,7 @@ Class | Method | HTTP request | Description
 *SibApiV3Sdk::ContactsApi* | [**get_list**](docs/ContactsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get the details of a list
 *SibApiV3Sdk::ContactsApi* | [**get_lists**](docs/ContactsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
 *SibApiV3Sdk::ContactsApi* | [**import_contacts**](docs/ContactsApi.md#import_contacts) | **POST** /contacts/import | Import contacts
-*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
+*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
 *SibApiV3Sdk::ContactsApi* | [**request_contact_export**](docs/ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
 *SibApiV3Sdk::ContactsApi* | [**update_attribute**](docs/ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
 *SibApiV3Sdk::ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Updates a contact
@@ -132,19 +132,19 @@ Class | Method | HTTP request | Description
 *SibApiV3Sdk::ListsApi* | [**get_folder_lists**](docs/ListsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder
 *SibApiV3Sdk::ListsApi* | [**get_list**](docs/ListsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get the details of a list
 *SibApiV3Sdk::ListsApi* | [**get_lists**](docs/ListsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
-*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
+*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
 *SibApiV3Sdk::ListsApi* | [**update_list**](docs/ListsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
 *SibApiV3Sdk::ProcessApi* | [**get_process**](docs/ProcessApi.md#get_process) | **GET** /processes/{processId} | Return the informations for a process
 *SibApiV3Sdk::ProcessApi* | [**get_processes**](docs/ProcessApi.md#get_processes) | **GET** /processes | Return all the processes for your account
-*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
-*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
+*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
+*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
 *SibApiV3Sdk::ResellerApi* | [**create_reseller_child**](docs/ResellerApi.md#create_reseller_child) | **POST** /reseller/children | Creates a reseller child
-*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
-*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
-*SibApiV3Sdk::ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childId} | Gets the info about a specific child account
+*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
+*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
+*SibApiV3Sdk::ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | Gets the info about a specific child account
 *SibApiV3Sdk::ResellerApi* | [**get_reseller_childs**](docs/ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Gets the list of all reseller's children accounts
-*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
-*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
+*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
+*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
 *SibApiV3Sdk::SMSCampaignsApi* | [**create_sms_campaign**](docs/SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign
 *SibApiV3Sdk::SMSCampaignsApi* | [**delete_sms_campaign**](docs/SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign
 *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
 
 ## Documentation for Models
 
+ - [SibApiV3Sdk::AddContactToList](docs/AddContactToList.md)
  - [SibApiV3Sdk::AddCredits](docs/AddCredits.md)
- - [SibApiV3Sdk::AddRemoveContactToList](docs/AddRemoveContactToList.md)
  - [SibApiV3Sdk::CreateAttribute](docs/CreateAttribute.md)
  - [SibApiV3Sdk::CreateAttributeEnumeration](docs/CreateAttributeEnumeration.md)
  - [SibApiV3Sdk::CreateChild](docs/CreateChild.md)
@@ -197,6 +197,7 @@ Class | Method | HTTP request | Description
  - [SibApiV3Sdk::CreateEmailCampaignSender](docs/CreateEmailCampaignSender.md)
  - [SibApiV3Sdk::CreateList](docs/CreateList.md)
  - [SibApiV3Sdk::CreateModel](docs/CreateModel.md)
+ - [SibApiV3Sdk::CreateReseller](docs/CreateReseller.md)
  - [SibApiV3Sdk::CreateSender](docs/CreateSender.md)
  - [SibApiV3Sdk::CreateSenderIps](docs/CreateSenderIps.md)
  - [SibApiV3Sdk::CreateSenderModel](docs/CreateSenderModel.md)
@@ -223,8 +224,9 @@ Class | Method | HTTP request | Description
  - [SibApiV3Sdk::GetCampaignRecipients](docs/GetCampaignRecipients.md)
  - [SibApiV3Sdk::GetCampaignStats](docs/GetCampaignStats.md)
  - [SibApiV3Sdk::GetChildInfoApiKeys](docs/GetChildInfoApiKeys.md)
+ - [SibApiV3Sdk::GetChildInfoApiKeysV2](docs/GetChildInfoApiKeysV2.md)
+ - [SibApiV3Sdk::GetChildInfoApiKeysV3](docs/GetChildInfoApiKeysV3.md)
  - [SibApiV3Sdk::GetChildInfoCredits](docs/GetChildInfoCredits.md)
- - [SibApiV3Sdk::GetChildInfoIps](docs/GetChildInfoIps.md)
  - [SibApiV3Sdk::GetChildInfoStatistics](docs/GetChildInfoStatistics.md)
  - [SibApiV3Sdk::GetChildrenList](docs/GetChildrenList.md)
  - [SibApiV3Sdk::GetClient](docs/GetClient.md)
@@ -289,6 +291,7 @@ Class | Method | HTTP request | Description
  - [SibApiV3Sdk::RemainingCreditModel](docs/RemainingCreditModel.md)
  - [SibApiV3Sdk::RemainingCreditModelChild](docs/RemainingCreditModelChild.md)
  - [SibApiV3Sdk::RemainingCreditModelReseller](docs/RemainingCreditModelReseller.md)
+ - [SibApiV3Sdk::RemoveContactFromList](docs/RemoveContactFromList.md)
  - [SibApiV3Sdk::RemoveCredits](docs/RemoveCredits.md)
  - [SibApiV3Sdk::RequestContactExport](docs/RequestContactExport.md)
  - [SibApiV3Sdk::RequestContactImport](docs/RequestContactImport.md)

diff --git a/docs/AddContactToList.md b/docs/AddContactToList.md
@@ -0,0 +1,8 @@
+# SibApiV3Sdk::AddContactToList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**emails** | **Array&lt;String&gt;** | Emails to add to a list | [optional] 
+
+
diff --git a/docs/AddCredits.md b/docs/AddCredits.md
@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sms** | **Integer** | SMS credits to be added to the child account | [optional] 
-**email** | **Integer** | Email credits to be added to the child account | [optional] 
+**sms** | **Integer** | Required if email credits are empty. SMS credits to be added to the child account | [optional] 
+**email** | **Integer** | Required if sms credits are empty. Email credits to be added to the child account | [optional] 
 
 
diff --git a/docs/AddRemoveContactToList.md b/docs/AddRemoveContactToList.md
diff --git a/docs/ContactsApi.md b/docs/ContactsApi.md
@@ -23,7 +23,7 @@ Method | HTTP request | Description
 [**get_list**](ContactsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get the details of a list
 [**get_lists**](ContactsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
 [**import_contacts**](ContactsApi.md#import_contacts) | **POST** /contacts/import | Import contacts
-[**remove_contact_to_list**](ContactsApi.md#remove_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
+[**remove_contact_from_list**](ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
 [**request_contact_export**](ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
 [**update_attribute**](ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
 [**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Updates a contact
@@ -52,7 +52,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
 
 list_id = 789 # Integer | Id of the list
 
-contact_emails = SibApiV3Sdk::AddRemoveContactToList.new # AddRemoveContactToList | Emails addresses of the contacts
+contact_emails = SibApiV3Sdk::AddContactToList.new # AddContactToList | Emails addresses of the contacts
 
 
 begin
@@ -69,7 +69,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **list_id** | **Integer**| Id of the list | 
- **contact_emails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails addresses of the contacts | 
+ **contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses of the contacts | 
 
 ### Return type
 
@@ -1048,8 +1048,8 @@ Name | Type | Description  | Notes
 
 
 
-# **remove_contact_to_list**
-> PostContactInfo remove_contact_to_list(list_id, contact_emails)
+# **remove_contact_from_list**
+> PostContactInfo remove_contact_from_list(list_id, contact_emails)
 
 Remove existing contacts from a list
 
@@ -1069,15 +1069,15 @@ api_instance = SibApiV3Sdk::ContactsApi.new
 
 list_id = 789 # Integer | Id of the list
 
-contact_emails = SibApiV3Sdk::AddRemoveContactToList.new # AddRemoveContactToList | Emails adresses of the contact
+contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails adresses of the contact
 
 
 begin
   #Remove existing contacts from a list
-  result = api_instance.remove_contact_to_list(list_id, contact_emails)
+  result = api_instance.remove_contact_from_list(list_id, contact_emails)
   p result
 rescue SibApiV3Sdk::ApiError => e
-  puts "Exception when calling ContactsApi->remove_contact_to_list: #{e}"
+  puts "Exception when calling ContactsApi->remove_contact_from_list: #{e}"
 end
 ```
 
@@ -1086,7 +1086,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **list_id** | **Integer**| Id of the list | 
- **contact_emails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails adresses of the contact | 
+ **contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails adresses of the contact | 
 
 ### Return type
 

diff --git a/docs/CreateReseller.md b/docs/CreateReseller.md
@@ -0,0 +1,8 @@
+# SibApiV3Sdk::CreateReseller
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**auth_key** | **String** | AuthKey of Reseller child created | 
+
+
diff --git a/docs/GetChildInfo.md b/docs/GetChildInfo.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **credits** | [**GetChildInfoCredits**](GetChildInfoCredits.md) |  | [optional] 
 **statistics** | [**GetChildInfoStatistics**](GetChildInfoStatistics.md) |  | [optional] 
 **password** | **String** | The encrypted password of child account | 
-**ips** | [**Array&lt;GetChildInfoIps&gt;**](GetChildInfoIps.md) | IP(s) associated to a child account user | [optional] 
-**api_keys** | [**Array&lt;GetChildInfoApiKeys&gt;**](GetChildInfoApiKeys.md) | API Keys associated to child account | [optional] 
+**ips** | **Array&lt;String&gt;** | IP(s) associated to a child account user | [optional] 
+**api_keys** | [**GetChildInfoApiKeys**](GetChildInfoApiKeys.md) |  | [optional] 
 
 
diff --git a/docs/GetChildInfoApiKeys.md b/docs/GetChildInfoApiKeys.md
@@ -3,8 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | Name of the key | 
-**key** | **String** | API Key | 
-**secret** | **String** | Secret Key associated to the API Key (in case v1 Key is used only) | [optional] 
+**v2** | [**Array&lt;GetChildInfoApiKeysV2&gt;**](GetChildInfoApiKeysV2.md) |  | 
+**v3** | [**Array&lt;GetChildInfoApiKeysV3&gt;**](GetChildInfoApiKeysV3.md) |  | [optional] 
 
 
diff --git a/docs/GetChildInfoApiKeysV2.md b/docs/GetChildInfoApiKeysV2.md
@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetChildInfoApiKeysV2
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the key for version 2 | 
+**key** | **String** | API Key for version 2 | 
+
+
diff --git a/docs/GetChildInfoApiKeysV3.md b/docs/GetChildInfoApiKeysV3.md
@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetChildInfoApiKeysV3
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the key for version 3 | 
+**key** | **String** | API Key for version 3 | 
+
+
diff --git a/docs/GetChildInfoIps.md b/docs/GetChildInfoIps.md
diff --git a/docs/GetEmailCampaign.md b/docs/GetEmailCampaign.md
@@ -23,5 +23,7 @@ Name | Type | Description | Notes
 **inline_image_activation** | **BOOLEAN** | Status of inline image. inlineImageActivation &#x3D; false means image can’t be embedded, &amp; inlineImageActivation &#x3D; true means image can be embedded, in the email. | [optional] 
 **mirror_active** | **BOOLEAN** | Status of mirror links in campaign. mirrorActive &#x3D; false means mirror links are deactivated, &amp; mirrorActive &#x3D; true means mirror links are activated, in the campaign | [optional] 
 **recurring** | **BOOLEAN** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring &#x3D; false means contact can receive the same Trigger campaign only once, &amp; recurring &#x3D; true means contact can receive the same Trigger campaign several times | [optional] 
+**recipients** | **Object** |  | 
+**statistics** | **Object** |  | 
 
 
diff --git a/docs/GetSmsCampaign.md b/docs/GetSmsCampaign.md
@@ -12,5 +12,7 @@ Name | Type | Description | Notes
 **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) | 
+**recipients** | **Object** |  | 
+**statistics** | **Object** |  | 
 
 
diff --git a/docs/ListsApi.md b/docs/ListsApi.md
@@ -11,7 +11,7 @@ Method | HTTP request | Description
 [**get_folder_lists**](ListsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder
 [**get_list**](ListsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get the details of a list
 [**get_lists**](ListsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
-[**remove_contact_to_list**](ListsApi.md#remove_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
+[**remove_contact_from_list**](ListsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
 [**update_list**](ListsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
 
 
@@ -36,7 +36,7 @@ api_instance = SibApiV3Sdk::ListsApi.new
 
 list_id = 789 # Integer | Id of the list
 
-contact_emails = SibApiV3Sdk::AddRemoveContactToList.new # AddRemoveContactToList | Emails addresses of the contacts
+contact_emails = SibApiV3Sdk::AddContactToList.new # AddContactToList | Emails addresses of the contacts
 
 
 begin
@@ -53,7 +53,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **list_id** | **Integer**| Id of the list | 
- **contact_emails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails addresses of the contacts | 
+ **contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses of the contacts | 
 
 ### Return type
 
@@ -398,8 +398,8 @@ Name | Type | Description  | Notes
 
 
 
-# **remove_contact_to_list**
-> PostContactInfo remove_contact_to_list(list_id, contact_emails)
+# **remove_contact_from_list**
+> PostContactInfo remove_contact_from_list(list_id, contact_emails)
 
 Remove existing contacts from a list
 
@@ -419,15 +419,15 @@ api_instance = SibApiV3Sdk::ListsApi.new
 
 list_id = 789 # Integer | Id of the list
 
-contact_emails = SibApiV3Sdk::AddRemoveContactToList.new # AddRemoveContactToList | Emails adresses of the contact
+contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails adresses of the contact
 
 
 begin
   #Remove existing contacts from a list
-  result = api_instance.remove_contact_to_list(list_id, contact_emails)
+  result = api_instance.remove_contact_from_list(list_id, contact_emails)
   p result
 rescue SibApiV3Sdk::ApiError => e
-  puts "Exception when calling ListsApi->remove_contact_to_list: #{e}"
+  puts "Exception when calling ListsApi->remove_contact_from_list: #{e}"
 end
 ```
 
@@ -436,7 +436,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **list_id** | **Integer**| Id of the list | 
- **contact_emails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails adresses of the contact | 
+ **contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails adresses of the contact | 
 
 ### Return type
 

diff --git a/docs/ManageIp.md b/docs/ManageIp.md
@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**ip_id** | **Integer** | ID of the IP | [optional] 
+**ip** | **String** | Dedicated ID | [optional] 
 
 
diff --git a/docs/RemoveContactFromList.md b/docs/RemoveContactFromList.md
@@ -0,0 +1,9 @@
+# SibApiV3Sdk::RemoveContactFromList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**emails** | **Array&lt;String&gt;** | Required if &#39;all&#39; is false. Emails to remove from a list | [optional] 
+**all** | **BOOLEAN** | Required if &#39;emails&#39; is empty. Remove all existing contacts from a list | [optional] 
+
+