sib-api-v3-sdk 8.1.0 → 9.1.0

data/docs/{ListsApi.md → ConversationsApi.md}

@@ -1,24 +1,26 @@
-# SibApiV3Sdk::ListsApi
+# SibApiV3Sdk::ConversationsApi
 
 All URIs are relative to *https://api.sendinblue.com/v3*
 
 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 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 | Delete a contact from a list
-[**update_list**](ListsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
+[**conversations_agent_online_ping_post**](ConversationsApi.md#conversations_agent_online_ping_post) | **POST** /conversations/agentOnlinePing | Sets agent’s status to online for 2-3 minutes
+[**conversations_messages_id_delete**](ConversationsApi.md#conversations_messages_id_delete) | **DELETE** /conversations/messages/{id} | Delete a message sent by an agent
+[**conversations_messages_id_get**](ConversationsApi.md#conversations_messages_id_get) | **GET** /conversations/messages/{id} | Get a message
+[**conversations_messages_id_put**](ConversationsApi.md#conversations_messages_id_put) | **PUT** /conversations/messages/{id} | Update a message sent by an agent
+[**conversations_messages_post**](ConversationsApi.md#conversations_messages_post) | **POST** /conversations/messages | Send a message as an agent
+[**conversations_pushed_messages_id_delete**](ConversationsApi.md#conversations_pushed_messages_id_delete) | **DELETE** /conversations/pushedMessages/{id} | Delete an automated message
+[**conversations_pushed_messages_id_get**](ConversationsApi.md#conversations_pushed_messages_id_get) | **GET** /conversations/pushedMessages/{id} | Get an automated message
+[**conversations_pushed_messages_id_put**](ConversationsApi.md#conversations_pushed_messages_id_put) | **PUT** /conversations/pushedMessages/{id} | Update an automated message
+[**conversations_pushed_messages_post**](ConversationsApi.md#conversations_pushed_messages_post) | **POST** /conversations/pushedMessages | Send an automated message to a visitor
 
 
-# **add_contact_to_list**
-> PostContactInfo add_contact_to_list(list_id, contact_emails)
+# **conversations_agent_online_ping_post**
+> conversations_agent_online_ping_post(body)
 
-Add existing contacts to a list
+Sets agent’s status to online for 2-3 minutes
+
+We recommend pinging this endpoint every minute for as long as the agent has to be considered online.
 
 ### Example
 ```ruby
@@ -37,19 +39,16 @@ SibApiV3Sdk.configure do |config|
   #config.api_key_prefix['partner-key'] = 'Bearer'
 end
 
-api_instance = SibApiV3Sdk::ListsApi.new
-
-list_id = 789 # Integer | Id of the list
+api_instance = SibApiV3Sdk::ConversationsApi.new
 
-contact_emails = SibApiV3Sdk::AddContactToList.new # AddContactToList | Emails addresses OR IDs of the contacts
+body = SibApiV3Sdk::Body12.new # Body12 | Agent fields.
 
 
 begin
-  #Add existing contacts to a list
-  result = api_instance.add_contact_to_list(list_id, contact_emails)
-  p result
+  #Sets agent’s status to online for 2-3 minutes
+  api_instance.conversations_agent_online_ping_post(body)
 rescue SibApiV3Sdk::ApiError => e
-  puts "Exception when calling ListsApi->add_contact_to_list: #{e}"
+  puts "Exception when calling ConversationsApi->conversations_agent_online_ping_post: #{e}"
 end
 ```
 
@@ -57,12 +56,11 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **list_id** | **Integer**| Id of the list | 
- **contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses OR IDs of the contacts | 
+ **body** | [**Body12**](Body12.md)| Agent fields. | 
 
 ### Return type
 
-[**PostContactInfo**](PostContactInfo.md)
+nil (empty response body)
 
 ### Authorization
 
@@ -75,10 +73,12 @@ Name | Type | Description  | Notes
 
 
 
-# **create_list**
-> CreateModel create_list(create_list)
+# **conversations_messages_id_delete**
+> conversations_messages_id_delete(id)
+
+Delete a message sent by an agent
 
-Create a list
+Only agents’ messages can be deleted.
 
 ### Example
 ```ruby
@@ -97,17 +97,16 @@ SibApiV3Sdk.configure do |config|
   #config.api_key_prefix['partner-key'] = 'Bearer'
 end
 
-api_instance = SibApiV3Sdk::ListsApi.new
+api_instance = SibApiV3Sdk::ConversationsApi.new
 
-create_list = SibApiV3Sdk::CreateList.new # CreateList | Values to create a list
+id = 'id_example' # String | ID of the message
 
 
 begin
-  #Create a list
-  result = api_instance.create_list(create_list)
-  p result
+  #Delete a message sent by an agent
+  api_instance.conversations_messages_id_delete(id)
 rescue SibApiV3Sdk::ApiError => e
-  puts "Exception when calling ListsApi->create_list: #{e}"
+  puts "Exception when calling ConversationsApi->conversations_messages_id_delete: #{e}"
 end
 ```
 
@@ -115,11 +114,11 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **create_list** | [**CreateList**](CreateList.md)| Values to create a list | 
+ **id** | **String**| ID of the message | 
 
 ### Return type
 
-[**CreateModel**](CreateModel.md)
+nil (empty response body)
 
 ### Authorization
 
@@ -132,10 +131,10 @@ Name | Type | Description  | Notes
 
 
 
-# **delete_list**
-> delete_list(list_id)
+# **conversations_messages_id_get**
+> ConversationsMessage conversations_messages_id_get(id)
 
-Delete a list
+Get a message
 
 ### Example
 ```ruby
@@ -154,16 +153,17 @@ SibApiV3Sdk.configure do |config|
   #config.api_key_prefix['partner-key'] = 'Bearer'
 end
 
-api_instance = SibApiV3Sdk::ListsApi.new
+api_instance = SibApiV3Sdk::ConversationsApi.new
 
-list_id = 789 # Integer | Id of the list
+id = 'id_example' # String | ID of the message
 
 
 begin
-  #Delete a list
-  api_instance.delete_list(list_id)
+  #Get a message
+  result = api_instance.conversations_messages_id_get(id)
+  p result
 rescue SibApiV3Sdk::ApiError => e
-  puts "Exception when calling ListsApi->delete_list: #{e}"
+  puts "Exception when calling ConversationsApi->conversations_messages_id_get: #{e}"
 end
 ```
 
@@ -171,11 +171,11 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **list_id** | **Integer**| Id of the list | 
+ **id** | **String**| ID of the message | 
 
 ### Return type
 
-nil (empty response body)
+[**ConversationsMessage**](ConversationsMessage.md)
 
 ### Authorization
 
@@ -188,10 +188,12 @@ nil (empty response body)
 
 
 
-# **get_contacts_from_list**
-> GetContacts get_contacts_from_list(list_id, opts)
+# **conversations_messages_id_put**
+> ConversationsMessage conversations_messages_id_put(id, opts)
 
-Get contacts in a list
+Update a message sent by an agent
+
+Only agents’ messages can be edited.
 
 ### Example
 ```ruby
@@ -210,23 +212,20 @@ SibApiV3Sdk.configure do |config|
   #config.api_key_prefix['partner-key'] = 'Bearer'
 end
 
-api_instance = SibApiV3Sdk::ListsApi.new
+api_instance = SibApiV3Sdk::ConversationsApi.new
 
-list_id = 789 # Integer | Id of the list
+id = 'id_example' # String | ID of the message
 
 opts = { 
-  modified_since: 'modified_since_example', # String | 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
-  sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
+  body: SibApiV3Sdk::Body9.new # Body9 | 
 }
 
 begin
-  #Get contacts in a list
-  result = api_instance.get_contacts_from_list(list_id, opts)
+  #Update a message sent by an agent
+  result = api_instance.conversations_messages_id_put(id, opts)
   p result
 rescue SibApiV3Sdk::ApiError => e
-  puts "Exception when calling ListsApi->get_contacts_from_list: #{e}"
+  puts "Exception when calling ConversationsApi->conversations_messages_id_put: #{e}"
 end
 ```
 
@@ -234,15 +233,12 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **list_id** | **Integer**| Id of the list | 
- **modified_since** | **String**| 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. | [optional] 
- **limit** | **Integer**| Number of documents per page | [optional] [default to 50]
- **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**| ID of the message | 
+ **body** | [**Body9**](Body9.md)|  | [optional] 
 
 ### Return type
 
-[**GetContacts**](GetContacts.md)
+[**ConversationsMessage**](ConversationsMessage.md)
 
 ### Authorization
 
@@ -255,10 +251,10 @@ Name | Type | Description  | Notes
 
 
 
-# **get_folder_lists**
-> GetFolderLists get_folder_lists(folder_id, opts)
+# **conversations_messages_post**
+> ConversationsMessage conversations_messages_post(body)
 
-Get lists in a folder
+Send a message as an agent
 
 ### Example
 ```ruby
@@ -277,22 +273,17 @@ SibApiV3Sdk.configure do |config|
   #config.api_key_prefix['partner-key'] = 'Bearer'
 end
 
-api_instance = SibApiV3Sdk::ListsApi.new
+api_instance = SibApiV3Sdk::ConversationsApi.new
 
-folder_id = 789 # Integer | Id of the folder
+body = SibApiV3Sdk::Body8.new # Body8 | Message fields.
 
-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)
+  #Send a message as an agent
+  result = api_instance.conversations_messages_post(body)
   p result
 rescue SibApiV3Sdk::ApiError => e
-  puts "Exception when calling ListsApi->get_folder_lists: #{e}"
+  puts "Exception when calling ConversationsApi->conversations_messages_post: #{e}"
 end
 ```
 
@@ -300,14 +291,11 @@ 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]
+ **body** | [**Body8**](Body8.md)| Message fields. | 
 
 ### Return type
 
-[**GetFolderLists**](GetFolderLists.md)
+[**ConversationsMessage**](ConversationsMessage.md)
 
 ### Authorization
 
@@ -320,10 +308,10 @@ Name | Type | Description  | Notes
 
 
 
-# **get_list**
-> GetExtendedList get_list(list_id)
+# **conversations_pushed_messages_id_delete**
+> conversations_pushed_messages_id_delete(id)
 
-Get a list's details
+Delete an automated message
 
 ### Example
 ```ruby
@@ -342,17 +330,16 @@ SibApiV3Sdk.configure do |config|
   #config.api_key_prefix['partner-key'] = 'Bearer'
 end
 
-api_instance = SibApiV3Sdk::ListsApi.new
+api_instance = SibApiV3Sdk::ConversationsApi.new
 
-list_id = 789 # Integer | Id of the list
+id = 'id_example' # String | ID of the message
 
 
 begin
-  #Get a list's details
-  result = api_instance.get_list(list_id)
-  p result
+  #Delete an automated message
+  api_instance.conversations_pushed_messages_id_delete(id)
 rescue SibApiV3Sdk::ApiError => e
-  puts "Exception when calling ListsApi->get_list: #{e}"
+  puts "Exception when calling ConversationsApi->conversations_pushed_messages_id_delete: #{e}"
 end
 ```
 
@@ -360,11 +347,11 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **list_id** | **Integer**| Id of the list | 
+ **id** | **String**| ID of the message | 
 
 ### Return type
 
-[**GetExtendedList**](GetExtendedList.md)
+nil (empty response body)
 
 ### Authorization
 
@@ -377,10 +364,10 @@ Name | Type | Description  | Notes
 
 
 
-# **get_lists**
-> GetLists get_lists(opts)
+# **conversations_pushed_messages_id_get**
+> ConversationsMessage conversations_pushed_messages_id_get(id)
 
-Get all the lists
+Get an automated message
 
 ### Example
 ```ruby
@@ -399,20 +386,17 @@ SibApiV3Sdk.configure do |config|
   #config.api_key_prefix['partner-key'] = 'Bearer'
 end
 
-api_instance = SibApiV3Sdk::ListsApi.new
+api_instance = SibApiV3Sdk::ConversationsApi.new
+
+id = 'id_example' # String | ID of the message sent previously
 
-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 all the lists
-  result = api_instance.get_lists(opts)
+  #Get an automated message
+  result = api_instance.conversations_pushed_messages_id_get(id)
   p result
 rescue SibApiV3Sdk::ApiError => e
-  puts "Exception when calling ListsApi->get_lists: #{e}"
+  puts "Exception when calling ConversationsApi->conversations_pushed_messages_id_get: #{e}"
 end
 ```
 
@@ -420,13 +404,11 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **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**| ID of the message sent previously | 
 
 ### Return type
 
-[**GetLists**](GetLists.md)
+[**ConversationsMessage**](ConversationsMessage.md)
 
 ### Authorization
 
@@ -439,10 +421,10 @@ Name | Type | Description  | Notes
 
 
 
-# **remove_contact_from_list**
-> PostContactInfo remove_contact_from_list(list_id, contact_emails)
+# **conversations_pushed_messages_id_put**
+> ConversationsMessage conversations_pushed_messages_id_put(id, body)
 
-Delete a contact from a list
+Update an automated message
 
 ### Example
 ```ruby
@@ -461,19 +443,19 @@ SibApiV3Sdk.configure do |config|
   #config.api_key_prefix['partner-key'] = 'Bearer'
 end
 
-api_instance = SibApiV3Sdk::ListsApi.new
+api_instance = SibApiV3Sdk::ConversationsApi.new
 
-list_id = 789 # Integer | Id of the list
+id = 'id_example' # String | ID of the message
 
-contact_emails = SibApiV3Sdk::RemoveContactFromList.new # RemoveContactFromList | Emails addresses OR IDs of the contacts
+body = SibApiV3Sdk::Body11.new # Body11 | 
 
 
 begin
-  #Delete a contact from a list
-  result = api_instance.remove_contact_from_list(list_id, contact_emails)
+  #Update an automated message
+  result = api_instance.conversations_pushed_messages_id_put(id, body)
   p result
 rescue SibApiV3Sdk::ApiError => e
-  puts "Exception when calling ListsApi->remove_contact_from_list: #{e}"
+  puts "Exception when calling ConversationsApi->conversations_pushed_messages_id_put: #{e}"
 end
 ```
 
@@ -481,12 +463,12 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **list_id** | **Integer**| Id of the list | 
- **contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails addresses OR IDs of the contacts | 
+ **id** | **String**| ID of the message | 
+ **body** | [**Body11**](Body11.md)|  | 
 
 ### Return type
 
-[**PostContactInfo**](PostContactInfo.md)
+[**ConversationsMessage**](ConversationsMessage.md)
 
 ### Authorization
 
@@ -499,10 +481,12 @@ Name | Type | Description  | Notes
 
 
 
-# **update_list**
-> update_list(list_id, update_list)
+# **conversations_pushed_messages_post**
+> ConversationsMessage conversations_pushed_messages_post(body)
+
+Send an automated message to a visitor
 
-Update a list
+Example of automated messages: order status, announce new features in your web app, etc.
 
 ### Example
 ```ruby
@@ -521,18 +505,17 @@ SibApiV3Sdk.configure do |config|
   #config.api_key_prefix['partner-key'] = 'Bearer'
 end
 
-api_instance = SibApiV3Sdk::ListsApi.new
-
-list_id = 789 # Integer | Id of the list
+api_instance = SibApiV3Sdk::ConversationsApi.new
 
-update_list = SibApiV3Sdk::UpdateList.new # UpdateList | Values to update a list
+body = SibApiV3Sdk::Body10.new # Body10 | 
 
 
 begin
-  #Update a list
-  api_instance.update_list(list_id, update_list)
+  #Send an automated message to a visitor
+  result = api_instance.conversations_pushed_messages_post(body)
+  p result
 rescue SibApiV3Sdk::ApiError => e
-  puts "Exception when calling ListsApi->update_list: #{e}"
+  puts "Exception when calling ConversationsApi->conversations_pushed_messages_post: #{e}"
 end
 ```
 
@@ -540,12 +523,11 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **list_id** | **Integer**| Id of the list | 
- **update_list** | [**UpdateList**](UpdateList.md)| Values to update a list | 
+ **body** | [**Body10**](Body10.md)|  | 
 
 ### Return type
 
-nil (empty response body)
+[**ConversationsMessage**](ConversationsMessage.md)
 
 ### Authorization
 

data/docs/ConversationsMessage.md

@@ -0,0 +1,17 @@
+# SibApiV3Sdk::ConversationsMessage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Message ID. It can be used for further manipulations with the message. | [optional] 
+**type** | **String** | `\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages. | [optional] 
+**text** | **String** | Message text or name of the attached file | [optional] 
+**visitor_id** | **String** | visitor’s ID | [optional] 
+**agent_id** | **String** | ID of the agent on whose behalf the message was sent (only in messages sent by an agent). | [optional] 
+**agent_name** | **String** | Agent’s name as displayed to the visitor. Only in the messages sent by an agent. | [optional] 
+**created_at** | **Integer** | Timestamp in milliseconds. | [optional] 
+**is_pushed** | **BOOLEAN** | `true` for pushed messages | [optional] 
+**received_from** | **String** | In two-way integrations, messages sent via REST API can be marked with receivedFrom property and then filtered out when received in a webhook to avoid infinite loop. | [optional] 
+**file** | [**ConversationsMessageFile**](ConversationsMessageFile.md) |  | [optional] 
+
+

data/docs/ConversationsMessageFile.md

@@ -0,0 +1,12 @@
+# SibApiV3Sdk::ConversationsMessageFile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filename** | **String** | Name of the file | [optional] 
+**size** | **Integer** | Size in bytes | [optional] 
+**is_image** | **BOOLEAN** | Whether the file is an image | [optional] 
+**url** | **String** | URL of the file | [optional] 
+**image_info** | [**ConversationsMessageFileImageInfo**](ConversationsMessageFileImageInfo.md) |  | [optional] 
+
+

data/docs/ConversationsMessageFileImageInfo.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::ConversationsMessageFileImageInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**width** | **Integer** | Width of the image | [optional] 
+**height** | **Integer** | height of the image | [optional] 
+**preview_url** | **String** | URL of the preview | [optional] 
+
+

data/docs/CreateContact.md

@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **email** | **String** | Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. 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 and their values. These attributes must be present in your SendinBlue account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} | [optional] 
+**attributes** | **Object** | Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. These attributes must be present in your SendinBlue account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} | [optional] 
 **email_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional] 
 **sms_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional] 
 **list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional] 

data/docs/CreateEmailCampaign.md

@@ -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** | Mandatory if ipWarmupEnable is set to true. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. | [optional] 
 **increase_rate** | **Integer** | Mandatory if ipWarmupEnable is set to true. 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. If not entered, then the default unsubscription page will be used. | [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. If not entered, then the default update profile form will be used. | [optional] 
 
 

data/docs/CreateEmailCampaignRecipients.md

@@ -5,5 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **exclusion_list_ids** | **Array<Integer>** | List ids to exclude from the campaign | [optional] 
 **list_ids** | **Array<Integer>** | Mandatory if scheduledAt is not empty. List Ids to send the campaign to | [optional] 
+**segment_ids** | **Array<Integer>** | Mandatory if listIds are not used. Segment ids to send the campaign to. | [optional] 
 
 

data/docs/CreateSubAccount.md

@@ -3,9 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**company_name** | **String** | Name of the organization | 
+**company_name** | **String** | Set the name of the sub-account company | 
 **email** | **String** | Email address for the organization | 
-**language** | **String** | Language for identifying localization information | [optional] 
-**timezone** | **String** | Request timezone of the client | [optional] 
+**language** | **String** | Set the language of the sub-account | [optional] 
+**timezone** | **String** | Set the timezone of the sub-account | [optional] 
 
 

data/docs/CreateSubAccountResponse.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::CreateSubAccountResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the sub-account created | 
+
+

data/docs/Deal.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::Deal
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique deal id | [optional] 
+**attributes** | **Object** | Deal attributes with values | [optional] 
+**linked_contacts_ids** | **Array<Integer>** | Contact ids for contacts linked to this deal | [optional] 
+**linked_companies_ids** | **Array<String>** | Companies ids for companies linked to this deal | [optional] 
+
+

data/docs/DealAttributes.md

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

data/docs/DealAttributesInner.md

@@ -0,0 +1,12 @@
+# SibApiV3Sdk::DealAttributesInner
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**internal_name** | **String** |  | [optional] 
+**label** | **String** |  | [optional] 
+**attribute_type_name** | **String** |  | [optional] 
+**attribute_options** | **Array<Object>** |  | [optional] 
+**is_required** | **BOOLEAN** |  | [optional] 
+
+