sib-api-v3-sdk 8.1.0 → 9.1.0

data/docs/{FoldersApi.md → TasksApi.md}

@@ -1,21 +1,21 @@
-# SibApiV3Sdk::FoldersApi
+# SibApiV3Sdk::TasksApi
 
 All URIs are relative to *https://api.sendinblue.com/v3*
 
 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 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
+[**crm_tasks_get**](TasksApi.md#crm_tasks_get) | **GET** /crm/tasks | Get all tasks
+[**crm_tasks_id_delete**](TasksApi.md#crm_tasks_id_delete) | **DELETE** /crm/tasks/{id} | Delete a task
+[**crm_tasks_id_get**](TasksApi.md#crm_tasks_id_get) | **GET** /crm/tasks/{id} | Get a task
+[**crm_tasks_id_patch**](TasksApi.md#crm_tasks_id_patch) | **PATCH** /crm/tasks/{id} | Update a task
+[**crm_tasks_post**](TasksApi.md#crm_tasks_post) | **POST** /crm/tasks | Create a task
+[**crm_tasktypes_get**](TasksApi.md#crm_tasktypes_get) | **GET** /crm/tasktypes | Get all task types
 
 
-# **create_folder**
-> CreateModel create_folder(create_folder)
+# **crm_tasks_get**
+> TaskList crm_tasks_get(opts)
 
-Create a folder
+Get all tasks
 
 ### Example
 ```ruby
@@ -34,17 +34,30 @@ SibApiV3Sdk.configure do |config|
   #config.api_key_prefix['partner-key'] = 'Bearer'
 end
 
-api_instance = SibApiV3Sdk::FoldersApi.new
-
-create_folder = SibApiV3Sdk::CreateUpdateFolder.new # CreateUpdateFolder | Name of the folder
+api_instance = SibApiV3Sdk::TasksApi.new
 
+opts = { 
+  filter_type: 'filter_type_example', # String | Filter by task type (ID)
+  filter_status: 'filter_status_example', # String | Filter by task status
+  filter_date: 'filter_date_example', # String | Filter by date
+  filter_assign_to: 'filter_assign_to_example', # String | Filter by assignTo id
+  filter_contacts: 'filter_contacts_example', # String | Filter by contact ids
+  filter_deals: 'filter_deals_example', # String | Filter by deals ids
+  filter_companies: 'filter_companies_example', # String | Filter by companies ids
+  date_from: 56, # Integer | dateFrom to date range filter type (timestamp in milliseconds)
+  date_to: 56, # Integer | dateTo to date range filter type (timestamp in milliseconds)
+  offset: 789, # Integer | Index of the first document of the page
+  limit: 50, # Integer | Number of documents per page
+  sort: 'sort_example', # String | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
+  sort_by: 'sort_by_example' # String | The field used to sort field names.
+}
 
 begin
-  #Create a folder
-  result = api_instance.create_folder(create_folder)
+  #Get all tasks
+  result = api_instance.crm_tasks_get(opts)
   p result
 rescue SibApiV3Sdk::ApiError => e
-  puts "Exception when calling FoldersApi->create_folder: #{e}"
+  puts "Exception when calling TasksApi->crm_tasks_get: #{e}"
 end
 ```
 
@@ -52,11 +65,23 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **create_folder** | [**CreateUpdateFolder**](CreateUpdateFolder.md)| Name of the folder | 
+ **filter_type** | **String**| Filter by task type (ID) | [optional] 
+ **filter_status** | **String**| Filter by task status | [optional] 
+ **filter_date** | **String**| Filter by date | [optional] 
+ **filter_assign_to** | **String**| Filter by assignTo id | [optional] 
+ **filter_contacts** | **String**| Filter by contact ids | [optional] 
+ **filter_deals** | **String**| Filter by deals ids | [optional] 
+ **filter_companies** | **String**| Filter by companies ids | [optional] 
+ **date_from** | **Integer**| dateFrom to date range filter type (timestamp in milliseconds) | [optional] 
+ **date_to** | **Integer**| dateTo to date range filter type (timestamp in milliseconds) | [optional] 
+ **offset** | **Integer**| Index of the first document of the page | [optional] 
+ **limit** | **Integer**| Number of documents per page | [optional] [default to 50]
+ **sort** | **String**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional] 
+ **sort_by** | **String**| The field used to sort field names. | [optional] 
 
 ### Return type
 
-[**CreateModel**](CreateModel.md)
+[**TaskList**](TaskList.md)
 
 ### Authorization
 
@@ -69,10 +94,10 @@ Name | Type | Description  | Notes
 
 
 
-# **delete_folder**
-> delete_folder(folder_id)
+# **crm_tasks_id_delete**
+> crm_tasks_id_delete(id)
 
-Delete a folder (and all its lists)
+Delete a task
 
 ### Example
 ```ruby
@@ -91,16 +116,16 @@ SibApiV3Sdk.configure do |config|
   #config.api_key_prefix['partner-key'] = 'Bearer'
 end
 
-api_instance = SibApiV3Sdk::FoldersApi.new
+api_instance = SibApiV3Sdk::TasksApi.new
 
-folder_id = 789 # Integer | Id of the folder
+id = 'id_example' # String | 
 
 
 begin
-  #Delete a folder (and all its lists)
-  api_instance.delete_folder(folder_id)
+  #Delete a task
+  api_instance.crm_tasks_id_delete(id)
 rescue SibApiV3Sdk::ApiError => e
-  puts "Exception when calling FoldersApi->delete_folder: #{e}"
+  puts "Exception when calling TasksApi->crm_tasks_id_delete: #{e}"
 end
 ```
 
@@ -108,7 +133,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **folder_id** | **Integer**| Id of the folder | 
+ **id** | **String**|  | 
 
 ### Return type
 
@@ -125,10 +150,10 @@ nil (empty response body)
 
 
 
-# **get_folder**
-> GetFolder get_folder(folder_id)
+# **crm_tasks_id_get**
+> Task crm_tasks_id_get(id)
 
-Returns a folder's details
+Get a task
 
 ### Example
 ```ruby
@@ -147,17 +172,17 @@ SibApiV3Sdk.configure do |config|
   #config.api_key_prefix['partner-key'] = 'Bearer'
 end
 
-api_instance = SibApiV3Sdk::FoldersApi.new
+api_instance = SibApiV3Sdk::TasksApi.new
 
-folder_id = 789 # Integer | id of the folder
+id = 'id_example' # String | 
 
 
 begin
-  #Returns a folder's details
-  result = api_instance.get_folder(folder_id)
+  #Get a task
+  result = api_instance.crm_tasks_id_get(id)
   p result
 rescue SibApiV3Sdk::ApiError => e
-  puts "Exception when calling FoldersApi->get_folder: #{e}"
+  puts "Exception when calling TasksApi->crm_tasks_id_get: #{e}"
 end
 ```
 
@@ -165,11 +190,11 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **folder_id** | **Integer**| id of the folder | 
+ **id** | **String**|  | 
 
 ### Return type
 
-[**GetFolder**](GetFolder.md)
+[**Task**](Task.md)
 
 ### Authorization
 
@@ -182,10 +207,10 @@ Name | Type | Description  | Notes
 
 
 
-# **get_folder_lists**
-> GetFolderLists get_folder_lists(folder_id, opts)
+# **crm_tasks_id_patch**
+> crm_tasks_id_patch(id, body)
 
-Get lists in a folder
+Update a task
 
 ### Example
 ```ruby
@@ -204,22 +229,18 @@ SibApiV3Sdk.configure do |config|
   #config.api_key_prefix['partner-key'] = 'Bearer'
 end
 
-api_instance = SibApiV3Sdk::FoldersApi.new
+api_instance = SibApiV3Sdk::TasksApi.new
 
-folder_id = 789 # Integer | Id of the folder
+id = 'id_example' # String | 
+
+body = SibApiV3Sdk::Body7.new # Body7 | Updated task details.
 
-opts = { 
-  limit: 10, # Integer | Number of documents per page
-  offset: 0, # Integer | Index of the first document of the page
-  sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
-}
 
 begin
-  #Get lists in a folder
-  result = api_instance.get_folder_lists(folder_id, opts)
-  p result
+  #Update a task
+  api_instance.crm_tasks_id_patch(id, body)
 rescue SibApiV3Sdk::ApiError => e
-  puts "Exception when calling FoldersApi->get_folder_lists: #{e}"
+  puts "Exception when calling TasksApi->crm_tasks_id_patch: #{e}"
 end
 ```
 
@@ -227,14 +248,12 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **folder_id** | **Integer**| Id of the folder | 
- **limit** | **Integer**| Number of documents per page | [optional] [default to 10]
- **offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
- **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
+ **id** | **String**|  | 
+ **body** | [**Body7**](Body7.md)| Updated task details. | 
 
 ### Return type
 
-[**GetFolderLists**](GetFolderLists.md)
+nil (empty response body)
 
 ### Authorization
 
@@ -247,10 +266,10 @@ Name | Type | Description  | Notes
 
 
 
-# **get_folders**
-> GetFolders get_folders(limit, offset, opts)
+# **crm_tasks_post**
+> InlineResponse2011 crm_tasks_post(body)
 
-Get all folders
+Create a task
 
 ### Example
 ```ruby
@@ -269,22 +288,17 @@ SibApiV3Sdk.configure do |config|
   #config.api_key_prefix['partner-key'] = 'Bearer'
 end
 
-api_instance = SibApiV3Sdk::FoldersApi.new
+api_instance = SibApiV3Sdk::TasksApi.new
 
-limit = 10 # Integer | Number of documents per page
+body = SibApiV3Sdk::Body6.new # Body6 | Task name.
 
-offset = 0 # Integer | Index of the first document of the page
-
-opts = { 
-  sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
-}
 
 begin
-  #Get all folders
-  result = api_instance.get_folders(limit, offset, opts)
+  #Create a task
+  result = api_instance.crm_tasks_post(body)
   p result
 rescue SibApiV3Sdk::ApiError => e
-  puts "Exception when calling FoldersApi->get_folders: #{e}"
+  puts "Exception when calling TasksApi->crm_tasks_post: #{e}"
 end
 ```
 
@@ -292,13 +306,11 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **limit** | **Integer**| Number of documents per page | [default to 10]
- **offset** | **Integer**| Index of the first document of the page | [default to 0]
- **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
+ **body** | [**Body6**](Body6.md)| Task name. | 
 
 ### Return type
 
-[**GetFolders**](GetFolders.md)
+[**InlineResponse2011**](InlineResponse2011.md)
 
 ### Authorization
 
@@ -311,10 +323,10 @@ Name | Type | Description  | Notes
 
 
 
-# **update_folder**
-> update_folder(folder_id, update_folder)
+# **crm_tasktypes_get**
+> TaskTypes crm_tasktypes_get
 
-Update a folder
+Get all task types
 
 ### Example
 ```ruby
@@ -333,31 +345,23 @@ SibApiV3Sdk.configure do |config|
   #config.api_key_prefix['partner-key'] = 'Bearer'
 end
 
-api_instance = SibApiV3Sdk::FoldersApi.new
-
-folder_id = 789 # Integer | Id of the folder
-
-update_folder = SibApiV3Sdk::CreateUpdateFolder.new # CreateUpdateFolder | Name of the folder
-
+api_instance = SibApiV3Sdk::TasksApi.new
 
 begin
-  #Update a folder
-  api_instance.update_folder(folder_id, update_folder)
+  #Get all task types
+  result = api_instance.crm_tasktypes_get
+  p result
 rescue SibApiV3Sdk::ApiError => e
-  puts "Exception when calling FoldersApi->update_folder: #{e}"
+  puts "Exception when calling TasksApi->crm_tasktypes_get: #{e}"
 end
 ```
 
 ### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **folder_id** | **Integer**| Id of the folder | 
- **update_folder** | [**CreateUpdateFolder**](CreateUpdateFolder.md)| Name of the folder | 
+This endpoint does not need any parameter.
 
 ### Return type
 
-nil (empty response body)
+[**TaskTypes**](TaskTypes.md)
 
 ### Authorization
 

data/docs/TransactionalEmailsApi.md

@@ -8,10 +8,13 @@ Method | HTTP request | Description
 [**create_smtp_template**](TransactionalEmailsApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
 [**delete_blocked_domain**](TransactionalEmailsApi.md#delete_blocked_domain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains
 [**delete_hardbounces**](TransactionalEmailsApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
+[**delete_scheduled_email_by_id**](TransactionalEmailsApi.md#delete_scheduled_email_by_id) | **DELETE** /smtp/email/{identifier} | Delete scheduled emails by batchId or messageId
 [**delete_smtp_template**](TransactionalEmailsApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
 [**get_aggregated_smtp_report**](TransactionalEmailsApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
 [**get_blocked_domains**](TransactionalEmailsApi.md#get_blocked_domains) | **GET** /smtp/blockedDomains | Get the list of blocked domains
 [**get_email_event_report**](TransactionalEmailsApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
+[**get_scheduled_email_by_batch_id**](TransactionalEmailsApi.md#get_scheduled_email_by_batch_id) | **GET** /smtp/emailStatus/{batchId} | Fetch scheduled emails by batchId
+[**get_scheduled_email_by_message_id**](TransactionalEmailsApi.md#get_scheduled_email_by_message_id) | **GET** /smtp/emailStatus/{messageId} | Fetch scheduled email by messageId
 [**get_smtp_report**](TransactionalEmailsApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
 [**get_smtp_template**](TransactionalEmailsApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
 [**get_smtp_templates**](TransactionalEmailsApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates
@@ -257,6 +260,64 @@ nil (empty response body)
 
 
 
+# **delete_scheduled_email_by_id**
+> delete_scheduled_email_by_id(identifier)
+
+Delete scheduled emails by batchId or messageId
+
+Delete scheduled batch of emails by batchId or single scheduled email by messageId
+
+### Example
+```ruby
+# load the gem
+require 'sib-api-v3-sdk'
+# setup authorization
+SibApiV3Sdk.configure do |config|
+  # Configure API key authorization: api-key
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+
+  # Configure API key authorization: partner-key
+  config.api_key['partner-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['partner-key'] = 'Bearer'
+end
+
+api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
+
+identifier = 'identifier_example' # String | The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email.
+
+
+begin
+  #Delete scheduled emails by batchId or messageId
+  api_instance.delete_scheduled_email_by_id(identifier)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling TransactionalEmailsApi->delete_scheduled_email_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **delete_smtp_template**
 > delete_smtp_template(template_id)
 
@@ -459,7 +520,7 @@ end
 api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
 
 opts = { 
-  limit: 50, # Integer | Number limitation for the result returned
+  limit: 2500, # Integer | Number limitation for the result returned
   offset: 0, # Integer | Beginning point in the list to retrieve from.
   start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
   end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
@@ -485,7 +546,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **limit** | **Integer**| Number limitation for the result returned | [optional] [default to 50]
+ **limit** | **Integer**| Number limitation for the result returned | [optional] [default to 2500]
  **offset** | **Integer**| Beginning point in the list to retrieve from. | [optional] [default to 0]
  **start_date** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional] 
  **end_date** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional] 
@@ -512,6 +573,144 @@ Name | Type | Description  | Notes
 
 
 
+# **get_scheduled_email_by_batch_id**
+> GetScheduledEmailByBatchId get_scheduled_email_by_batch_id(batch_id, opts)
+
+Fetch scheduled emails by batchId
+
+Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old)
+
+### Example
+```ruby
+# load the gem
+require 'sib-api-v3-sdk'
+# setup authorization
+SibApiV3Sdk.configure do |config|
+  # Configure API key authorization: api-key
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+
+  # Configure API key authorization: partner-key
+  config.api_key['partner-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['partner-key'] = 'Bearer'
+end
+
+api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
+
+batch_id = 'batch_id_example' # String | The batchId of scheduled emails batch (Should be a valid UUIDv4)
+
+opts = { 
+  start_date: Date.parse('2013-10-20'), # Date | Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
+  end_date: Date.parse('2013-10-20'), # Date | Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
+  sort: 'desc', # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
+  status: 'status_example', # String | Filter the records by `status` of the scheduled email batch or message.
+  limit: 100, # Integer | Number of documents returned per page
+  offset: 0 # Integer | Index of the first document on the page
+}
+
+begin
+  #Fetch scheduled emails by batchId
+  result = api_instance.get_scheduled_email_by_batch_id(batch_id, opts)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling TransactionalEmailsApi->get_scheduled_email_by_batch_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **batch_id** | **String**| The batchId of scheduled emails batch (Should be a valid UUIDv4) | 
+ **start_date** | **Date**| Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. | [optional] 
+ **end_date** | **Date**| Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional] 
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
+ **status** | **String**| Filter the records by `status` of the scheduled email batch or message. | [optional] 
+ **limit** | **Integer**| Number of documents returned per page | [optional] [default to 100]
+ **offset** | **Integer**| Index of the first document on the page | [optional] [default to 0]
+
+### Return type
+
+[**GetScheduledEmailByBatchId**](GetScheduledEmailByBatchId.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_scheduled_email_by_message_id**
+> GetScheduledEmailByMessageId get_scheduled_email_by_message_id(message_id, opts)
+
+Fetch scheduled email by messageId
+
+Fetch scheduled email by messageId (Can retrieve data upto 30 days old)
+
+### Example
+```ruby
+# load the gem
+require 'sib-api-v3-sdk'
+# setup authorization
+SibApiV3Sdk.configure do |config|
+  # Configure API key authorization: api-key
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+
+  # Configure API key authorization: partner-key
+  config.api_key['partner-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['partner-key'] = 'Bearer'
+end
+
+api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
+
+message_id = 'message_id_example' # String | The messageId of scheduled email
+
+opts = { 
+  start_date: Date.parse('2013-10-20'), # Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
+  end_date: Date.parse('2013-10-20') # Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
+}
+
+begin
+  #Fetch scheduled email by messageId
+  result = api_instance.get_scheduled_email_by_message_id(message_id, opts)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling TransactionalEmailsApi->get_scheduled_email_by_message_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **message_id** | **String**| The messageId of scheduled email | 
+ **start_date** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. | [optional] 
+ **end_date** | **Date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional] 
+
+### Return type
+
+[**GetScheduledEmailByMessageId**](GetScheduledEmailByMessageId.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_smtp_report**
 > GetReports get_smtp_report(opts)
 

data/docs/UpdateContact.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**attributes** | **Object** | Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} | [optional] 
+**attributes** | **Object** | Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. The attribute's parameter should be passed in capital letter while updating a contact. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} | [optional] 
 **email_blacklisted** | **BOOLEAN** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | [optional] 
 **sms_blacklisted** | **BOOLEAN** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional] 
 **list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional] 

data/docs/UpdateEmailCampaign.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 **tag** | **String** | Tag of the campaign | [optional] 
 **sender** | [**UpdateEmailCampaignSender**](UpdateEmailCampaignSender.md) |  | [optional] 
 **name** | **String** | Name of the campaign | [optional] 
-**html_content** | **String** | Body of the message (HTML version). REQUIRED if htmlUrl is empty | [optional] 
+**html_content** | **String** | Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. REQUIRED if htmlUrl is empty | [optional] 
 **html_url** | **String** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional] 
 **scheduled_at** | **String** | 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. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional] 
 **subject** | **String** | Subject of the campaign | [optional] 
@@ -31,5 +31,7 @@ Name | Type | Description | Notes
 **ip_warmup_enable** | **BOOLEAN** | Available for dedicated ip clients. Set this to true if you wish to warm up your ip. | [optional] [default to false]
 **initial_quota** | **Integer** | Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. | [optional] 
 **increase_rate** | **Integer** | Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. | [optional] 
+**unsubscription_page_id** | **String** | Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. | [optional] 
+**update_form_id** | **String** | Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. | [optional] 
 
 

data/docs/UpdateEmailCampaignRecipients.md

@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **exclusion_list_ids** | **Array<Integer>** | List ids which have to be excluded from a campaign | [optional] 
-**list_ids** | **Array<Integer>** | Lists Ids to send the campaign to. REQUIRED if already not present in campaign and scheduledAt is not empty | [optional] 
+**list_ids** | **Array<Integer>** | Lists Ids to send the campaign to. Campaign should only be updated with listIds if listIds were used to create it. REQUIRED if already not present in campaign and scheduledAt is not empty | [optional] 
+**segment_ids** | **Array<Integer>** | Mandatory if listIds are not used. Campaign should only be updated with segmentIds if segmentIds were used to create it. Segment ids to send the campaign to. | [optional] 
 
 

data/docs/UpdateSmtpTemplate.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 **tag** | **String** | Tag of the template | [optional] 
 **sender** | [**UpdateSmtpTemplateSender**](UpdateSmtpTemplateSender.md) |  | [optional] 
 **template_name** | **String** | Name of the template | [optional] 
-**html_content** | **String** | Required if htmlUrl is empty. Body of the message (HTML must have more than 10 characters) | [optional] 
+**html_content** | **String** | Required if htmlUrl is empty. If the template is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that template. Body of the message (HTML must have more than 10 characters) | [optional] 
 **html_url** | **String** | Required if htmlContent is empty. URL to the body of the email (HTML) | [optional] 
 **subject** | **String** | Subject of the email | [optional] 
 **reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional] 

data/docs/UploadImageModel.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::UploadImageModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | URL of the image uploaded | 
+
+