sib-api-v3-sdk 5.5.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f95ab1900ea673f64cf7a1edee7db7c1810e8bc1018ea2e1933fbbb6d94a0059
-  data.tar.gz: 5545aac0b0762fdf65b9b105350a9699d49562d0e0626f77beadffeb17bec006
+  metadata.gz: 2d5ae9f7677f08c68dd975a99087579f7f9c287ea914ead9c8e0dc334372a8cb
+  data.tar.gz: b76d9f5fed3f391630b036afca1ba0b4d2c84c378f9da690dbf5583fb3b81397
 SHA512:
-  metadata.gz: 40d877f79b569f7f4d44f8972e72f7b64ce1a4068d309ba9c3007705ba4b7e62c102a61286aae544f7c450ee3c2c80f58ede98b103afe1aacf1dde544d509e05
-  data.tar.gz: fb703e781f1730fbfe885c3ae6bfe4e2d1cdc585945591a8dcbe43ba66cf5fbedee0263ecc83071e4edb1a02b0e031311061852c59b813c80de3171c255fcbfe
+  metadata.gz: 6fd7286ebde36f745c46dd47abb461afa013266a304914070dfcff437b47947df11006243072e43eae5c5cf2bebf9243dd427974a0c328d7449f820dab2cfed6
+  data.tar.gz: 496d441724ba52e603826505d2959b1c9adcb50f01990543659ae21374f96104f5c52da5ad25c9f2502d5c3a79178120e76e1256857665c351fc0a387e230d63

data/README.md

@@ -96,12 +96,12 @@ Class | Method | HTTP request | Description
 *SibApiV3Sdk::ContactsApi* | [**create_folder**](docs/ContactsApi.md#create_folder) | **POST** /contacts/folders | Create a folder
 *SibApiV3Sdk::ContactsApi* | [**create_list**](docs/ContactsApi.md#create_list) | **POST** /contacts/lists | Create a list
 *SibApiV3Sdk::ContactsApi* | [**delete_attribute**](docs/ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
-*SibApiV3Sdk::ContactsApi* | [**delete_contact**](docs/ContactsApi.md#delete_contact) | **DELETE** /contacts/{email} | Delete a contact
+*SibApiV3Sdk::ContactsApi* | [**delete_contact**](docs/ContactsApi.md#delete_contact) | **DELETE** /contacts/{identifier} | Delete a contact
 *SibApiV3Sdk::ContactsApi* | [**delete_folder**](docs/ContactsApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
 *SibApiV3Sdk::ContactsApi* | [**delete_list**](docs/ContactsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
 *SibApiV3Sdk::ContactsApi* | [**get_attributes**](docs/ContactsApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes
-*SibApiV3Sdk::ContactsApi* | [**get_contact_info**](docs/ContactsApi.md#get_contact_info) | **GET** /contacts/{email} | Get a contact's details
-*SibApiV3Sdk::ContactsApi* | [**get_contact_stats**](docs/ContactsApi.md#get_contact_stats) | **GET** /contacts/{email}/campaignStats | Get email campaigns' statistics for a contact
+*SibApiV3Sdk::ContactsApi* | [**get_contact_info**](docs/ContactsApi.md#get_contact_info) | **GET** /contacts/{identifier} | Get a contact's details
+*SibApiV3Sdk::ContactsApi* | [**get_contact_stats**](docs/ContactsApi.md#get_contact_stats) | **GET** /contacts/{identifier}/campaignStats | Get email campaigns' statistics for a contact
 *SibApiV3Sdk::ContactsApi* | [**get_contacts**](docs/ContactsApi.md#get_contacts) | **GET** /contacts | Get all the contacts
 *SibApiV3Sdk::ContactsApi* | [**get_contacts_from_list**](docs/ContactsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
 *SibApiV3Sdk::ContactsApi* | [**get_folder**](docs/ContactsApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
@@ -113,7 +113,7 @@ Class | Method | HTTP request | Description
 *SibApiV3Sdk::ContactsApi* | [**remove_contact_from_list**](docs/ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact 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} | Update contact attribute
-*SibApiV3Sdk::ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Update a contact
+*SibApiV3Sdk::ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PUT** /contacts/{identifier} | Update a contact
 *SibApiV3Sdk::ContactsApi* | [**update_folder**](docs/ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
 *SibApiV3Sdk::ContactsApi* | [**update_list**](docs/ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
 *SibApiV3Sdk::EmailCampaignsApi* | [**create_email_campaign**](docs/EmailCampaignsApi.md#create_email_campaign) | **POST** /emailCampaigns | Create an email campaign
@@ -172,29 +172,29 @@ Class | Method | HTTP request | Description
 *SibApiV3Sdk::SMSCampaignsApi* | [**send_test_sms**](docs/SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign
 *SibApiV3Sdk::SMSCampaignsApi* | [**update_sms_campaign**](docs/SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Update an SMS campaign
 *SibApiV3Sdk::SMSCampaignsApi* | [**update_sms_campaign_status**](docs/SMSCampaignsApi.md#update_sms_campaign_status) | **PUT** /smsCampaigns/{campaignId}/status | Update a campaign's status
-*SibApiV3Sdk::SMTPApi* | [**create_smtp_template**](docs/SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
-*SibApiV3Sdk::SMTPApi* | [**delete_hardbounces**](docs/SMTPApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
-*SibApiV3Sdk::SMTPApi* | [**delete_smtp_template**](docs/SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
-*SibApiV3Sdk::SMTPApi* | [**get_aggregated_smtp_report**](docs/SMTPApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
-*SibApiV3Sdk::SMTPApi* | [**get_email_event_report**](docs/SMTPApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
-*SibApiV3Sdk::SMTPApi* | [**get_smtp_report**](docs/SMTPApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
-*SibApiV3Sdk::SMTPApi* | [**get_smtp_template**](docs/SMTPApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
-*SibApiV3Sdk::SMTPApi* | [**get_smtp_templates**](docs/SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates
-*SibApiV3Sdk::SMTPApi* | [**get_transac_blocked_contacts**](docs/SMTPApi.md#get_transac_blocked_contacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
-*SibApiV3Sdk::SMTPApi* | [**get_transac_email_content**](docs/SMTPApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
-*SibApiV3Sdk::SMTPApi* | [**get_transac_emails_list**](docs/SMTPApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
-*SibApiV3Sdk::SMTPApi* | [**send_template**](docs/SMTPApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
-*SibApiV3Sdk::SMTPApi* | [**send_test_template**](docs/SMTPApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
-*SibApiV3Sdk::SMTPApi* | [**send_transac_email**](docs/SMTPApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
-*SibApiV3Sdk::SMTPApi* | [**smtp_blocked_contacts_email_delete**](docs/SMTPApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
-*SibApiV3Sdk::SMTPApi* | [**smtp_log_message_id_delete**](docs/SMTPApi.md#smtp_log_message_id_delete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
-*SibApiV3Sdk::SMTPApi* | [**update_smtp_template**](docs/SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template
 *SibApiV3Sdk::SendersApi* | [**create_sender**](docs/SendersApi.md#create_sender) | **POST** /senders | Create a new sender
 *SibApiV3Sdk::SendersApi* | [**delete_sender**](docs/SendersApi.md#delete_sender) | **DELETE** /senders/{senderId} | Delete a sender
 *SibApiV3Sdk::SendersApi* | [**get_ips**](docs/SendersApi.md#get_ips) | **GET** /senders/ips | Get all the dedicated IPs for your account
 *SibApiV3Sdk::SendersApi* | [**get_ips_from_sender**](docs/SendersApi.md#get_ips_from_sender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender
 *SibApiV3Sdk::SendersApi* | [**get_senders**](docs/SendersApi.md#get_senders) | **GET** /senders | Get the list of all your senders
 *SibApiV3Sdk::SendersApi* | [**update_sender**](docs/SendersApi.md#update_sender) | **PUT** /senders/{senderId} | Update a sender
+*SibApiV3Sdk::TransactionalEmailsApi* | [**create_smtp_template**](docs/TransactionalEmailsApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
+*SibApiV3Sdk::TransactionalEmailsApi* | [**delete_hardbounces**](docs/TransactionalEmailsApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
+*SibApiV3Sdk::TransactionalEmailsApi* | [**delete_smtp_template**](docs/TransactionalEmailsApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
+*SibApiV3Sdk::TransactionalEmailsApi* | [**get_aggregated_smtp_report**](docs/TransactionalEmailsApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
+*SibApiV3Sdk::TransactionalEmailsApi* | [**get_email_event_report**](docs/TransactionalEmailsApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
+*SibApiV3Sdk::TransactionalEmailsApi* | [**get_smtp_report**](docs/TransactionalEmailsApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
+*SibApiV3Sdk::TransactionalEmailsApi* | [**get_smtp_template**](docs/TransactionalEmailsApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
+*SibApiV3Sdk::TransactionalEmailsApi* | [**get_smtp_templates**](docs/TransactionalEmailsApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates
+*SibApiV3Sdk::TransactionalEmailsApi* | [**get_transac_blocked_contacts**](docs/TransactionalEmailsApi.md#get_transac_blocked_contacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
+*SibApiV3Sdk::TransactionalEmailsApi* | [**get_transac_email_content**](docs/TransactionalEmailsApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
+*SibApiV3Sdk::TransactionalEmailsApi* | [**get_transac_emails_list**](docs/TransactionalEmailsApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
+*SibApiV3Sdk::TransactionalEmailsApi* | [**send_template**](docs/TransactionalEmailsApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
+*SibApiV3Sdk::TransactionalEmailsApi* | [**send_test_template**](docs/TransactionalEmailsApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
+*SibApiV3Sdk::TransactionalEmailsApi* | [**send_transac_email**](docs/TransactionalEmailsApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
+*SibApiV3Sdk::TransactionalEmailsApi* | [**smtp_blocked_contacts_email_delete**](docs/TransactionalEmailsApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
+*SibApiV3Sdk::TransactionalEmailsApi* | [**smtp_log_message_id_delete**](docs/TransactionalEmailsApi.md#smtp_log_message_id_delete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
+*SibApiV3Sdk::TransactionalEmailsApi* | [**update_smtp_template**](docs/TransactionalEmailsApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template
 *SibApiV3Sdk::TransactionalSMSApi* | [**get_sms_events**](docs/TransactionalSMSApi.md#get_sms_events) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events)
 *SibApiV3Sdk::TransactionalSMSApi* | [**get_transac_aggregated_sms_report**](docs/TransactionalSMSApi.md#get_transac_aggregated_sms_report) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time
 *SibApiV3Sdk::TransactionalSMSApi* | [**get_transac_sms_report**](docs/TransactionalSMSApi.md#get_transac_sms_report) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day
@@ -209,6 +209,11 @@ Class | Method | HTTP request | Description
 ## Documentation for Models
 
  - [SibApiV3Sdk::AbTestCampaignResult](docs/AbTestCampaignResult.md)
+ - [SibApiV3Sdk::AbTestCampaignResultClickedLinks](docs/AbTestCampaignResultClickedLinks.md)
+ - [SibApiV3Sdk::AbTestCampaignResultStatistics](docs/AbTestCampaignResultStatistics.md)
+ - [SibApiV3Sdk::AbTestVersionClicks](docs/AbTestVersionClicks.md)
+ - [SibApiV3Sdk::AbTestVersionClicksInner](docs/AbTestVersionClicksInner.md)
+ - [SibApiV3Sdk::AbTestVersionStats](docs/AbTestVersionStats.md)
  - [SibApiV3Sdk::AddChildDomain](docs/AddChildDomain.md)
  - [SibApiV3Sdk::AddContactToList](docs/AddContactToList.md)
  - [SibApiV3Sdk::AddCredits](docs/AddCredits.md)

data/docs/AbTestCampaignResult.md

@@ -9,5 +9,7 @@ Name | Type | Description | Notes
 **open_rate** | **String** | Open rate for current winning version | [optional] 
 **click_rate** | **String** | Click rate for current winning version | [optional] 
 **winning_version_rate** | **String** | Open/Click rate for the winner version | [optional] 
+**statistics** | [**AbTestCampaignResultStatistics**](AbTestCampaignResultStatistics.md) |  | [optional] 
+**clicked_links** | [**AbTestCampaignResultClickedLinks**](AbTestCampaignResultClickedLinks.md) |  | [optional] 
 
 

data/docs/AbTestCampaignResultClickedLinks.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::AbTestCampaignResultClickedLinks
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**version_a** | [**AbTestVersionClicks**](AbTestVersionClicks.md) |  | 
+**version_b** | [**AbTestVersionClicks**](AbTestVersionClicks.md) |  | 
+
+

data/docs/AbTestCampaignResultStatistics.md

@@ -0,0 +1,13 @@
+# SibApiV3Sdk::AbTestCampaignResultStatistics
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**openers** | [**AbTestVersionStats**](AbTestVersionStats.md) |  | 
+**clicks** | [**AbTestVersionStats**](AbTestVersionStats.md) |  | 
+**unsubscribed** | [**AbTestVersionStats**](AbTestVersionStats.md) |  | 
+**hard_bounces** | [**AbTestVersionStats**](AbTestVersionStats.md) |  | 
+**soft_bounces** | [**AbTestVersionStats**](AbTestVersionStats.md) |  | 
+**complaints** | [**AbTestVersionStats**](AbTestVersionStats.md) |  | 
+
+

data/docs/AbTestVersionClicks.md

@@ -0,0 +1,7 @@
+# SibApiV3Sdk::AbTestVersionClicks
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/AbTestVersionClicksInner.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::AbTestVersionClicksInner
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**link** | **String** | URL of the link | 
+**clicks_count** | **Float** | Number of times a link is clicked | 
+**click_rate** | **String** | Percentage of clicks of link with respect to total clicks | 
+
+

data/docs/AbTestVersionStats.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::AbTestVersionStats
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**version_a** | **String** | percentage of an event for version A | 
+**version_b** | **String** | percentage of an event for version B | 
+
+

data/docs/AddContactToList.md

@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**emails** | **Array<String>** | Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional] 
+**emails** | **Array<String>** | Mandatory if IDs are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional] 
+**ids** | **Array<Integer>** | Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional] 
 
 

data/docs/ContactsApi.md

@@ -11,12 +11,12 @@ Method | HTTP request | Description
 [**create_folder**](ContactsApi.md#create_folder) | **POST** /contacts/folders | Create a folder
 [**create_list**](ContactsApi.md#create_list) | **POST** /contacts/lists | Create a list
 [**delete_attribute**](ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
-[**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /contacts/{email} | Delete a contact
+[**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /contacts/{identifier} | Delete a contact
 [**delete_folder**](ContactsApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
 [**delete_list**](ContactsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
 [**get_attributes**](ContactsApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes
-[**get_contact_info**](ContactsApi.md#get_contact_info) | **GET** /contacts/{email} | Get a contact's details
-[**get_contact_stats**](ContactsApi.md#get_contact_stats) | **GET** /contacts/{email}/campaignStats | Get email campaigns' statistics for a contact
+[**get_contact_info**](ContactsApi.md#get_contact_info) | **GET** /contacts/{identifier} | Get a contact's details
+[**get_contact_stats**](ContactsApi.md#get_contact_stats) | **GET** /contacts/{identifier}/campaignStats | Get email campaigns' statistics for a contact
 [**get_contacts**](ContactsApi.md#get_contacts) | **GET** /contacts | Get all the contacts
 [**get_contacts_from_list**](ContactsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
 [**get_folder**](ContactsApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
@@ -28,7 +28,7 @@ Method | HTTP request | Description
 [**remove_contact_from_list**](ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact 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} | Update contact attribute
-[**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Update a contact
+[**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{identifier} | Update a contact
 [**update_folder**](ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
 [**update_list**](ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
 
@@ -59,7 +59,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
 
 list_id = 789 # Integer | Id of the list
 
-contact_emails = SibApiV3Sdk::AddContactToList.new # AddContactToList | Emails addresses of the contacts
+contact_emails = SibApiV3Sdk::AddContactToList.new # AddContactToList | Emails addresses OR IDs of the contacts
 
 
 begin
@@ -76,7 +76,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **list_id** | **Integer**| Id of the list | 
- **contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses of the contacts | 
+ **contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses OR IDs of the contacts | 
 
 ### Return type
 
@@ -442,7 +442,7 @@ nil (empty response body)
 
 
 # **delete_contact**
-> delete_contact(email)
+> delete_contact(identifier)
 
 Delete a contact
 
@@ -465,12 +465,12 @@ end
 
 api_instance = SibApiV3Sdk::ContactsApi.new
 
-email = 'email_example' # String | Email (urlencoded) of the contact
+identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact
 
 
 begin
   #Delete a contact
-  api_instance.delete_contact(email)
+  api_instance.delete_contact(identifier)
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ContactsApi->delete_contact: #{e}"
 end
@@ -480,7 +480,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **email** | **String**| Email (urlencoded) of the contact | 
+ **identifier** | **String**| Email (urlencoded) OR ID of the contact | 
 
 ### Return type
 
@@ -661,7 +661,7 @@ This endpoint does not need any parameter.
 
 
 # **get_contact_info**
-> GetExtendedContactDetails get_contact_info(email)
+> GetExtendedContactDetails get_contact_info(identifier)
 
 Get a contact's details
 
@@ -684,12 +684,12 @@ end
 
 api_instance = SibApiV3Sdk::ContactsApi.new
 
-email = 'email_example' # String | Email (urlencoded) of the contact OR its SMS attribute value
+identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact OR its SMS attribute value
 
 
 begin
   #Get a contact's details
-  result = api_instance.get_contact_info(email)
+  result = api_instance.get_contact_info(identifier)
   p result
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ContactsApi->get_contact_info: #{e}"
@@ -700,7 +700,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **email** | **String**| Email (urlencoded) of the contact OR its SMS attribute value | 
+ **identifier** | **String**| Email (urlencoded) OR ID of the contact OR its SMS attribute value | 
 
 ### Return type
 
@@ -718,7 +718,7 @@ Name | Type | Description  | Notes
 
 
 # **get_contact_stats**
-> GetContactCampaignStats get_contact_stats(email, opts)
+> GetContactCampaignStats get_contact_stats(identifier, opts)
 
 Get email campaigns' statistics for a contact
 
@@ -741,7 +741,7 @@ end
 
 api_instance = SibApiV3Sdk::ContactsApi.new
 
-email = 'email_example' # String | Email address (urlencoded) of the contact
+identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact
 
 opts = { 
   start_date: Date.parse('2013-10-20'), # Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
@@ -750,7 +750,7 @@ opts = {
 
 begin
   #Get email campaigns' statistics for a contact
-  result = api_instance.get_contact_stats(email, opts)
+  result = api_instance.get_contact_stats(identifier, opts)
   p result
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ContactsApi->get_contact_stats: #{e}"
@@ -761,7 +761,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **email** | **String**| Email address (urlencoded) of the contact | 
+ **identifier** | **String**| Email (urlencoded) OR ID of the contact | 
  **start_date** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional] 
  **end_date** | **Date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate | [optional] 
 
@@ -1289,7 +1289,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
 
 list_id = 789 # Integer | Id of the list
 
-contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails adresses of the contact
+contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails addresses OR IDs of the contacts
 
 
 begin
@@ -1306,7 +1306,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **list_id** | **Integer**| Id of the list | 
- **contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails adresses of the contact | 
+ **contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails addresses OR IDs of the contacts | 
 
 ### Return type
 
@@ -1445,7 +1445,7 @@ nil (empty response body)
 
 
 # **update_contact**
-> update_contact(email, update_contact)
+> update_contact(identifier, update_contact)
 
 Update a contact
 
@@ -1468,14 +1468,14 @@ end
 
 api_instance = SibApiV3Sdk::ContactsApi.new
 
-email = 'email_example' # String | Email (urlencoded) of the contact
+identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact
 
 update_contact = SibApiV3Sdk::UpdateContact.new # UpdateContact | Values to update a contact
 
 
 begin
   #Update a contact
-  api_instance.update_contact(email, update_contact)
+  api_instance.update_contact(identifier, update_contact)
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ContactsApi->update_contact: #{e}"
 end
@@ -1485,7 +1485,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **email** | **String**| Email (urlencoded) of the contact | 
+ **identifier** | **String**| Email (urlencoded) OR ID of the contact | 
  **update_contact** | [**UpdateContact**](UpdateContact.md)| Values to update a contact | 
 
 ### Return type

data/docs/CreateDoiContact.md

@@ -8,6 +8,6 @@ Name | Type | Description | Notes
 **include_list_ids** | **Array<Integer>** | Lists under user account where contact should be added | 
 **exclude_list_ids** | **Array<Integer>** | Lists under user account where contact should not be added | [optional] 
 **template_id** | **Integer** | Id of the Double opt-in (DOI) template | 
-**redirection_url** | **String** | URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}. | [optional] 
+**redirection_url** | **String** | URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}. | 
 
 

data/docs/CreateSmsCampaign.md

@@ -4,7 +4,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 | 
+**sender** | **String** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** | 
 **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] 

data/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 – sent, 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 | 
+**events** | **Array<String>** | Events triggering the webhook. Possible values for Transactional type webhook – `sent` OR `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']
 
 

data/docs/GetAggregatedReport.md

@@ -3,18 +3,18 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**range** | **String** | Time frame of the report | 
-**requests** | **Integer** | Number of requests for the timeframe | 
-**delivered** | **Integer** | Number of delivered emails for the timeframe | 
-**hard_bounces** | **Integer** | Number of hardbounces for the timeframe | 
-**soft_bounces** | **Integer** | Number of softbounces for the timeframe | 
-**clicks** | **Integer** | Number of clicks for the timeframe | 
-**unique_clicks** | **Integer** | Number of unique clicks for the timeframe | 
-**opens** | **Integer** | Number of openings for the timeframe | 
-**unique_opens** | **Integer** | Number of unique openings for the timeframe | 
-**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 | 
+**range** | **String** | Time frame of the report | [optional] 
+**requests** | **Integer** | Number of requests for the timeframe | [optional] 
+**delivered** | **Integer** | Number of delivered emails for the timeframe | [optional] 
+**hard_bounces** | **Integer** | Number of hardbounces for the timeframe | [optional] 
+**soft_bounces** | **Integer** | Number of softbounces for the timeframe | [optional] 
+**clicks** | **Integer** | Number of clicks for the timeframe | [optional] 
+**unique_clicks** | **Integer** | Number of unique clicks for the timeframe | [optional] 
+**opens** | **Integer** | Number of openings for the timeframe | [optional] 
+**unique_opens** | **Integer** | Number of unique openings for the timeframe | [optional] 
+**spam_reports** | **Integer** | Number of complaint (spam report) for the timeframe | [optional] 
+**blocked** | **Integer** | Number of blocked contact emails for the timeframe | [optional] 
+**invalid** | **Integer** | Number of invalid emails for the timeframe | [optional] 
+**unsubscribed** | **Integer** | Number of unsubscribed emails for the timeframe | [optional] 
 
 

data/docs/GetCampaignStats.md

@@ -15,5 +15,6 @@ Name | Type | Description | Notes
 **unsubscriptions** | **Integer** | Number of unsubscription for the campaign | 
 **viewed** | **Integer** | Number of openings for the campaign | 
 **deferred** | **Integer** | Number of deferred emails for the campaign | [optional] 
+**return_bounce** | **Integer** | Total number of non-delivered campaigns for a particular campaign id. | [optional] 
 
 

data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md

@@ -4,6 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **event_time** | **DateTime** | UTC date-time of the event | 
-**ip** | **String** | IP from which the user has been unsubscribed | 
+**ip** | **String** | IP from which the user has been unsubscribed | [optional] 
 
 

data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **campaign_id** | **Integer** | ID of the campaign which generated the event | 
 **event_time** | **DateTime** | UTC date-time of the event | 
-**ip** | **String** | IP from which the user has unsubscribed | 
+**ip** | **String** | IP from which the user has unsubscribed | [optional] 
 
 

data/docs/ListsApi.md

@@ -41,7 +41,7 @@ api_instance = SibApiV3Sdk::ListsApi.new
 
 list_id = 789 # Integer | Id of the list
 
-contact_emails = SibApiV3Sdk::AddContactToList.new # AddContactToList | Emails addresses of the contacts
+contact_emails = SibApiV3Sdk::AddContactToList.new # AddContactToList | Emails addresses OR IDs of the contacts
 
 
 begin
@@ -58,7 +58,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **list_id** | **Integer**| Id of the list | 
- **contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses of the contacts | 
+ **contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses OR IDs of the contacts | 
 
 ### Return type
 
@@ -459,7 +459,7 @@ api_instance = SibApiV3Sdk::ListsApi.new
 
 list_id = 789 # Integer | Id of the list
 
-contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails adresses of the contact
+contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails addresses OR IDs of the contacts
 
 
 begin
@@ -476,7 +476,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **list_id** | **Integer**| Id of the list | 
- **contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails adresses of the contact | 
+ **contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails addresses OR IDs of the contacts | 
 
 ### Return type