sib-api-v3-sdk 5.2.3 → 5.5.0

data/docs/EmailExportRecipients.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**notify_url** | **String** | Webhook called once the export process is finished | [optional] 
+**notify_url** | **String** | Webhook called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] 
 **recipients_type** | **String** | Type of recipients to export for a campaign | 
 
 

data/docs/FoldersApi.md

@@ -6,10 +6,10 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**create_folder**](FoldersApi.md#create_folder) | **POST** /contacts/folders | Create a folder
 [**delete_folder**](FoldersApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
-[**get_folder**](FoldersApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns folder details
-[**get_folder_lists**](FoldersApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder
-[**get_folders**](FoldersApi.md#get_folders) | **GET** /contacts/folders | Get all the folders
-[**update_folder**](FoldersApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a contact folder
+[**get_folder**](FoldersApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
+[**get_folder_lists**](FoldersApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
+[**get_folders**](FoldersApi.md#get_folders) | **GET** /contacts/folders | Get all folders
+[**update_folder**](FoldersApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
 
 
 # **create_folder**
@@ -128,7 +128,7 @@ nil (empty response body)
 # **get_folder**
 > GetFolder get_folder(folder_id)
 
-Returns folder details
+Returns a folder's details
 
 ### Example
 ```ruby
@@ -153,7 +153,7 @@ folder_id = 789 # Integer | id of the folder
 
 
 begin
-  #Returns folder details
+  #Returns a folder's details
   result = api_instance.get_folder(folder_id)
   p result
 rescue SibApiV3Sdk::ApiError => e
@@ -185,7 +185,7 @@ Name | Type | Description  | Notes
 # **get_folder_lists**
 > GetFolderLists get_folder_lists(folder_id, opts)
 
-Get the lists in a folder
+Get lists in a folder
 
 ### Example
 ```ruby
@@ -214,7 +214,7 @@ opts = {
 }
 
 begin
-  #Get the lists in a folder
+  #Get lists in a folder
   result = api_instance.get_folder_lists(folder_id, opts)
   p result
 rescue SibApiV3Sdk::ApiError => e
@@ -248,7 +248,7 @@ Name | Type | Description  | Notes
 # **get_folders**
 > GetFolders get_folders(limit, offset)
 
-Get all the folders
+Get all folders
 
 ### Example
 ```ruby
@@ -275,7 +275,7 @@ offset = 0 # Integer | Index of the first document of the page
 
 
 begin
-  #Get all the folders
+  #Get all folders
   result = api_instance.get_folders(limit, offset)
   p result
 rescue SibApiV3Sdk::ApiError => e
@@ -308,7 +308,7 @@ Name | Type | Description  | Notes
 # **update_folder**
 > update_folder(folder_id, update_folder)
 
-Update a contact folder
+Update a folder
 
 ### Example
 ```ruby
@@ -335,7 +335,7 @@ update_folder = SibApiV3Sdk::CreateUpdateFolder.new # CreateUpdateFolder | Name
 
 
 begin
-  #Update a contact folder
+  #Update a folder
   api_instance.update_folder(folder_id, update_folder)
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling FoldersApi->update_folder: #{e}"

data/docs/GetAccountRelay.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**enabled** | **BOOLEAN** | Status of your SMTP Account (true=Enabled, false=Disabled) | 
+**enabled** | **BOOLEAN** | Status of your transactional email Account (true=Enabled, false=Disabled) | 
 **data** | [**GetAccountRelayData**](GetAccountRelayData.md) |  | 
 
 

data/docs/GetAccountRelayData.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**user_name** | **String** | Email to use as login on SMTP | 
+**user_name** | **String** | Email to use as login on transactional platform | 
 **relay** | **String** | URL of the SMTP Relay | 
 **port** | **Integer** | Port used for SMTP Relay | 
 

data/docs/GetChildAccountCreationStatus.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::GetChildAccountCreationStatus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**child_account_created** | **BOOLEAN** | Status of child account creation whether it is successfully created (exists) or not. | 
+
+

data/docs/GetChildrenList.md

@@ -4,5 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **children** | **Array<Object>** | Your children's account information | [optional] 
+**count** | **Integer** | Number of child accounts | 
 
 

data/docs/GetDeviceBrowserStats.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::GetDeviceBrowserStats
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clickers** | **Integer** | Number of total clicks for the campaign using the particular browser | 
+**unique_clicks** | **Integer** | Number of unique clicks for the campaign using the particular browser | 
+**viewed** | **Integer** | Number of openings for the campaign using the particular browser | 
+**unique_views** | **Integer** | Number of unique openings for the campaign using the particular browser | 
+
+

data/docs/GetEmailCampaign.md

@@ -31,6 +31,7 @@ Name | Type | Description | Notes
 **mirror_active** | **BOOLEAN** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional] 
 **recurring** | **BOOLEAN** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional] 
 **sent_date** | **DateTime** | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [optional] 
+**return_bounce** | **Integer** | Total number of non-delivered campaigns for a particular campaign id. | [optional] 
 **recipients** | **Object** |  | 
 **statistics** | **Object** |  | 
 

data/docs/GetExtendedCampaignOverview.md

@@ -31,5 +31,6 @@ Name | Type | Description | Notes
 **mirror_active** | **BOOLEAN** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional] 
 **recurring** | **BOOLEAN** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional] 
 **sent_date** | **DateTime** | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [optional] 
+**return_bounce** | **Integer** | Total number of non-delivered campaigns for a particular campaign id. | [optional] 
 
 

data/docs/GetExtendedCampaignOverviewSender.md

@@ -5,5 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Sender name of the campaign | [optional] 
 **email** | **String** | Sender email of the campaign | [optional] 
+**id** | **String** | Sender id of the campaign | [optional] 
 
 

data/docs/GetExtendedCampaignStats.md

@@ -9,5 +9,7 @@ Name | Type | Description | Notes
 **remaining** | **Integer** | Number of remaning emails to send | 
 **links_stats** | **Object** | Statistics about the number of clicks for the links | 
 **stats_by_domain** | [**GetStatsByDomain**](GetStatsByDomain.md) |  | 
+**stats_by_device** | [**GetStatsByDevice**](GetStatsByDevice.md) | Statistics about the campaign on the basis of various devices | 
+**stats_by_browser** | [**GetStatsByBrowser**](GetStatsByBrowser.md) | Statistics about the campaign on the basis of various browsers | 
 
 

data/docs/GetSharedTemplateUrl.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::GetSharedTemplateUrl
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shared_url** | **String** | A unique URL for the email campaign or transactional template. This URL can be shared with other Sendinblue users. | 
+
+

data/docs/GetSmtpTemplateOverview.md

@@ -15,5 +15,6 @@ Name | Type | Description | Notes
 **html_content** | **String** | HTML content of the template | 
 **created_at** | **DateTime** | Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
 **modified_at** | **DateTime** | Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
+**doi_template** | **BOOLEAN** | It is true if template is a valid Double opt-in (DOI) template, otherwise it is false. This field will be available only in case of single template detail call. | [optional] 
 
 

data/docs/GetSmtpTemplateOverviewSender.md

@@ -5,5 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | From email for the template | [optional] 
 **email** | **String** | From email for the template | [optional] 
+**id** | **String** | Sender id of the template | [optional] 
 
 

data/docs/GetSmtpTemplates.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**count** | **Integer** | Count of smtp templates | [optional] 
+**count** | **Integer** | Count of transactional email templates | [optional] 
 **templates** | [**Array<GetSmtpTemplateOverview>**](GetSmtpTemplateOverview.md) |  | [optional] 
 
 

data/docs/GetStatsByBrowser.md

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

data/docs/GetStatsByDevice.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::GetStatsByDevice
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**desktop** | [**Hash<String, GetDeviceBrowserStats>**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of desktop devices | [optional] 
+**mobile** | [**Hash<String, GetDeviceBrowserStats>**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of mobile devices | [optional] 
+**tablet** | [**Hash<String, GetDeviceBrowserStats>**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of tablet devices | [optional] 
+**unknown** | [**Hash<String, GetDeviceBrowserStats>**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of unknown devices | [optional] 
+
+

data/docs/GetTransacBlockedContacts.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetTransacBlockedContacts
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** | Count of blocked or unsubscribed contact | [optional] 
+**contacts** | [**Array<GetTransacBlockedContactsContacts>**](GetTransacBlockedContactsContacts.md) |  | [optional] 
+
+

data/docs/GetTransacBlockedContactsContacts.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::GetTransacBlockedContactsContacts
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email address of the blocked or unsubscribed contact | 
+**sender_email** | **String** | Sender email address of the blocked or unsubscribed contact | 
+**reason** | [**GetTransacBlockedContactsReason**](GetTransacBlockedContactsReason.md) |  | 
+**blocked_at** | **DateTime** | Date when the contact was blocked or unsubscribed on | 
+
+

data/docs/GetTransacBlockedContactsReason.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetTransacBlockedContactsReason
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Reason code for blocking / unsubscribing (This code is safe for comparison) | [optional] 
+**message** | **String** | Reason for blocking / unsubscribing (This string is not safe for comparison) | [optional] 
+
+

data/docs/GetTransacEmailContent.md

@@ -0,0 +1,14 @@
+# SibApiV3Sdk::GetTransacEmailContent
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email address to which transactional email has been sent | 
+**subject** | **String** | Subject of the sent email | 
+**template_id** | **Integer** | Id of the template | [optional] 
+**date** | **DateTime** | Date on which transactional email was sent | 
+**events** | [**Array<GetTransacEmailContentEvents>**](GetTransacEmailContentEvents.md) | Series of events which occurred on the transactional email | 
+**body** | **String** | Actual content of the transactional email that has been sent | 
+**attachment_count** | **Integer** | Count of the attachments that were sent in the email | 
+
+

data/docs/GetTransacEmailContentEvents.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetTransacEmailContentEvents
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the event that occurred on the sent email | 
+**time** | **DateTime** | Time at which the event occurred | 
+
+

data/docs/GetTransacEmailsList.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::GetTransacEmailsList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transactional_emails** | [**Array<GetTransacEmailsListTransactionalEmails>**](GetTransacEmailsListTransactionalEmails.md) |  | [optional] 
+
+

data/docs/GetTransacEmailsListTransactionalEmails.md

@@ -0,0 +1,15 @@
+# SibApiV3Sdk::GetTransacEmailsListTransactionalEmails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email address to which transactional email has been sent | 
+**subject** | **String** | Subject of the sent email | 
+**template_id** | **Integer** | Id of the template | [optional] 
+**message_id** | **String** | Message Id of the sent email | 
+**uuid** | **String** | Unique id of the email sent to a particular contact | 
+**date** | **DateTime** | Date on which transactional email was sent | 
+**from** | **String** | Email address of the sender from which the email was sent | [optional] 
+**tags** | **Array<String>** | Tags used for your email | [optional] 
+
+

data/docs/ListsApi.md

@@ -7,11 +7,11 @@ Method | HTTP request | Description
 [**add_contact_to_list**](ListsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
 [**create_list**](ListsApi.md#create_list) | **POST** /contacts/lists | Create a list
 [**delete_list**](ListsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
-[**get_contacts_from_list**](ListsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get the contacts in a list
-[**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_contacts_from_list**](ListsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
+[**get_folder_lists**](ListsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
+[**get_list**](ListsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get a list's details
 [**get_lists**](ListsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
-[**remove_contact_from_list**](ListsApi.md#remove_contact_from_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 | Delete a contact from a list
 [**update_list**](ListsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
 
 
@@ -191,7 +191,7 @@ nil (empty response body)
 # **get_contacts_from_list**
 > GetContacts get_contacts_from_list(list_id, opts)
 
-Get the contacts in a list
+Get contacts in a list
 
 ### Example
 ```ruby
@@ -215,13 +215,13 @@ api_instance = SibApiV3Sdk::ListsApi.new
 list_id = 789 # Integer | Id of the list
 
 opts = { 
-  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.
+  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.
   limit: 50, # Integer | Number of documents per page
   offset: 0 # Integer | Index of the first document of the page
 }
 
 begin
-  #Get the contacts in a list
+  #Get contacts in a list
   result = api_instance.get_contacts_from_list(list_id, opts)
   p result
 rescue SibApiV3Sdk::ApiError => e
@@ -256,7 +256,7 @@ Name | Type | Description  | Notes
 # **get_folder_lists**
 > GetFolderLists get_folder_lists(folder_id, opts)
 
-Get the lists in a folder
+Get lists in a folder
 
 ### Example
 ```ruby
@@ -285,7 +285,7 @@ opts = {
 }
 
 begin
-  #Get the lists in a folder
+  #Get lists in a folder
   result = api_instance.get_folder_lists(folder_id, opts)
   p result
 rescue SibApiV3Sdk::ApiError => e
@@ -319,7 +319,7 @@ Name | Type | Description  | Notes
 # **get_list**
 > GetExtendedList get_list(list_id)
 
-Get the details of a list
+Get a list's details
 
 ### Example
 ```ruby
@@ -344,7 +344,7 @@ list_id = 789 # Integer | Id of the list
 
 
 begin
-  #Get the details of a list
+  #Get a list's details
   result = api_instance.get_list(list_id)
   p result
 rescue SibApiV3Sdk::ApiError => e
@@ -436,7 +436,7 @@ Name | Type | Description  | Notes
 # **remove_contact_from_list**
 > PostContactInfo remove_contact_from_list(list_id, contact_emails)
 
-Remove existing contacts from a list
+Delete a contact from a list
 
 ### Example
 ```ruby
@@ -463,7 +463,7 @@ contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList
 
 
 begin
-  #Remove existing contacts from a list
+  #Delete a contact from a list
   result = api_instance.remove_contact_from_list(list_id, contact_emails)
   p result
 rescue SibApiV3Sdk::ApiError => e

data/docs/PostContactInfoContacts.md

@@ -6,5 +6,6 @@ Name | Type | Description | Notes
 **success** | **Array<String>** |  | [optional] 
 **failure** | **Array<String>** |  | [optional] 
 **total** | **Integer** | Displays the count of total number of contacts removed from list when user opts for \"all\" option. | [optional] 
+**process_id** | **Integer** | Id of the process created to remove contacts from list when user opts for \"all\" option. | [optional] 
 
 

data/docs/RemainingCreditModelChild.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sms** | **Integer** | SMS Credits remaining for child account | 
-**email** | **Integer** | Email Credits remaining for child account | 
+**sms** | **Float** | SMS Credits remaining for child account | 
+**email** | **Float** | Email Credits remaining for child account | 
 
 

data/docs/RemainingCreditModelReseller.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sms** | **Integer** | SMS Credits remaining for reseller account | 
-**email** | **Integer** | Email Credits remaining for reseller account | 
+**sms** | **Float** | SMS Credits remaining for reseller account | 
+**email** | **Float** | Email Credits remaining for reseller account | 
 
 

data/docs/RemoveContactFromList.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**emails** | **Array<String>** | Required if 'all' is false. Emails to remove from a list | [optional] 
-**all** | **BOOLEAN** | Required if 'emails' is empty. Remove all existing contacts from a list | [optional] 
+**emails** | **Array<String>** | Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request. | [optional] 
+**all** | **BOOLEAN** | Required if 'emails' is empty. Remove all existing contacts from a list.  A process will be created in this scenario. You can fetch the process details to know about the progress | [optional]