sib-api-v3-sdk 7.5.0 → 9.0.0

data/docs/NotesApi.md

@@ -0,0 +1,312 @@
+# SibApiV3Sdk::NotesApi
+
+All URIs are relative to *https://api.sendinblue.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**crm_notes_get**](NotesApi.md#crm_notes_get) | **GET** /crm/notes | Get all notes
+[**crm_notes_id_delete**](NotesApi.md#crm_notes_id_delete) | **DELETE** /crm/notes/{id} | Delete a note
+[**crm_notes_id_get**](NotesApi.md#crm_notes_id_get) | **GET** /crm/notes/{id} | Get a note
+[**crm_notes_id_patch**](NotesApi.md#crm_notes_id_patch) | **PATCH** /crm/notes/{id} | Update a note
+[**crm_notes_post**](NotesApi.md#crm_notes_post) | **POST** /crm/notes | Create a note
+
+
+# **crm_notes_get**
+> NoteList crm_notes_get(opts)
+
+Get all notes
+
+### 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::NotesApi.new
+
+opts = { 
+  entity: 'entity_example', # String | Filter by note entity type
+  entity_ids: 'entity_ids_example', # String | Filter by note entity 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
+}
+
+begin
+  #Get all notes
+  result = api_instance.crm_notes_get(opts)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling NotesApi->crm_notes_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **entity** | **String**| Filter by note entity type | [optional] 
+ **entity_ids** | **String**| Filter by note entity 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] 
+
+### Return type
+
+[**NoteList**](NoteList.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **crm_notes_id_delete**
+> crm_notes_id_delete(id)
+
+Delete a note
+
+### 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::NotesApi.new
+
+id = 'id_example' # String | Note ID to delete
+
+
+begin
+  #Delete a note
+  api_instance.crm_notes_id_delete(id)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling NotesApi->crm_notes_id_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Note ID to delete | 
+
+### 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
+
+
+
+# **crm_notes_id_get**
+> Note crm_notes_id_get(id)
+
+Get a note
+
+### 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::NotesApi.new
+
+id = 'id_example' # String | Note ID to get
+
+
+begin
+  #Get a note
+  result = api_instance.crm_notes_id_get(id)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling NotesApi->crm_notes_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Note ID to get | 
+
+### Return type
+
+[**Note**](Note.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **crm_notes_id_patch**
+> crm_notes_id_patch(id, body)
+
+Update a note
+
+### 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::NotesApi.new
+
+id = 'id_example' # String | Note ID to update
+
+body = SibApiV3Sdk::NoteData.new # NoteData | Note data to update a note
+
+
+begin
+  #Update a note
+  api_instance.crm_notes_id_patch(id, body)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling NotesApi->crm_notes_id_patch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Note ID to update | 
+ **body** | [**NoteData**](NoteData.md)| Note data to update a note | 
+
+### 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
+
+
+
+# **crm_notes_post**
+> NoteId crm_notes_post(body)
+
+Create a note
+
+### 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::NotesApi.new
+
+body = SibApiV3Sdk::NoteData.new # NoteData | Note data to create a note.
+
+
+begin
+  #Create a note
+  result = api_instance.crm_notes_post(body)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling NotesApi->crm_notes_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**NoteData**](NoteData.md)| Note data to create a note. | 
+
+### Return type
+
+[**NoteId**](NoteId.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Pipeline.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::Pipeline
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**stages** | [**Array<PipelineStage>**](PipelineStage.md) | List of stages | [optional] 
+
+

data/docs/PipelineStage.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::PipelineStage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Stage id | [optional] 
+**name** | **String** | Stage name | [optional] 
+
+

data/docs/RequestContactExport.md

@@ -4,8 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **export_attributes** | **Array<String>** | List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email']. | [optional] 
-**contact_filter** | **Object** | This attribute has been deprecated and will be removed by January 1st, 2021. Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported. For example, {\"blacklisted\":true} will export all the blacklisted contacts.  | [optional] 
-**custom_contact_filter** | [**RequestContactExportCustomContactFilter**](RequestContactExportCustomContactFilter.md) |  | [optional] 
+**custom_contact_filter** | [**RequestContactExportCustomContactFilter**](RequestContactExportCustomContactFilter.md) |  | 
 **notify_url** | **String** | Webhook that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] 
 
 

data/docs/RequestContactImport.md

@@ -3,8 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**file_url** | **String** | Mandatory if fileBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv | [optional] 
-**file_body** | **String** | Mandatory if fileUrl is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files. | [optional] 
+**file_url** | **String** | Mandatory if fileBody or jsonBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv, .json | [optional] 
+**file_body** | **String** | Mandatory if fileUrl and jsonBody is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files. | [optional] 
+**json_body** | **Array<Hash<String, Object>>** | **Mandatory if fileUrl and fileBody is not defined.** JSON content to be imported. **Maximum allowed json body size is 10MB** . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of json body size while parsing. Please use fileUrl instead to import bigger files.  | [optional] 
 **list_ids** | **Array<Integer>** | Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7]. | [optional] 
 **notify_url** | **String** | URL that will be called once the import process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] 
 **new_list** | [**RequestContactImportNewList**](RequestContactImportNewList.md) |  | [optional] 

data/docs/ScheduleSmtpEmail.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::ScheduleSmtpEmail
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message_id** | **String** | Message ID of the transactional email scheduled | [optional] 
+**message_ids** | **Array<String>** |  | [optional] 
+**batch_id** | **String** | Batch ID of the batch transactional email scheduled | [optional] 
+
+

data/docs/SendSmtpEmail.md

@@ -11,11 +11,13 @@ Name | Type | Description | Notes
 **text_content** | **String** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional] 
 **subject** | **String** | Subject of the message. Mandatory if 'templateId' is not passed | [optional] 
 **reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) |  | [optional] 
-**attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional] 
-**headers** | **Object** | Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`. | [optional] 
-**template_id** | **Integer** | Id of the template. Mandatory if messageVersions are passed | [optional] 
+**attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv, pkpass and xlsm ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional] 
+**headers** | **Object** | Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\", \"idempotencyKey\":\"abc-123\"}`. | [optional] 
+**templateId** | **Integer** | Id of the template. | [optional] 
 **params** | **Object** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. | [optional] 
-**message_versions** | [**Array<SendSmtpEmailMessageVersions>**](SendSmtpEmailMessageVersions.md) | You can customize and send out multiple versions of a templateId. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. This feature is currently in its beta version. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails | [optional] 
+**message_versions** | [**Array<SendSmtpEmailMessageVersions>**](SendSmtpEmailMessageVersions.md) | You can customize and send out multiple versions of a mail. templateId can be customized only if global parameter contains templateId. htmlContent and textContent can be customized only if any of the two, htmlContent or textContent, is present in global parameters. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. Total number of recipients in one API request must not exceed 2000. However, you can still pass upto 99 recipients maximum in one message version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails | [optional] 
 **tags** | **Array<String>** | Tag your emails to find them more easily | [optional] 
+**scheduled_at** | **DateTime** | UTC date-time on which the email has to schedule (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for scheduling. There can be an expected delay of +5 minutes in scheduled email delivery. **Please note this feature is currently a public beta**. | [optional] 
+**batch_id** | **String** | Valid UUIDv4 batch id to identify the scheduled batches transactional email. If not passed we will create a valid UUIDv4 batch id at our end. | [optional] 
 
 

data/docs/SendTransacSms.md

@@ -9,5 +9,6 @@ Name | Type | Description | Notes
 **type** | **String** | Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. | [optional] [default to 'transactional']
 **tag** | **String** | Tag of the message | [optional] 
 **web_url** | **String** | Webhook to call for each event triggered by the message (delivered etc.) | [optional] 
+**unicode_enabled** | **BOOLEAN** | Format of the message. It indicates whether the content should be treated as unicode or not. | [optional] [default to false]
 
 

data/docs/SsoTokenRequest.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SsoTokenRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Id of the sub-account organization | 
+**email** | **String** | User email of sub-account organization | [optional] 
+
+

data/docs/SubAccountDetailsResponse.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::SubAccountDetailsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the sub-account user | [optional] 
+**email** | **String** | Email id of the sub-account organization | [optional] 
+**company_name** | **String** | Sub-account company name | [optional] 
+**plan_info** | [**SubAccountDetailsResponsePlanInfo**](SubAccountDetailsResponsePlanInfo.md) |  | [optional] 
+
+

data/docs/SubAccountDetailsResponsePlanInfo.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::SubAccountDetailsResponsePlanInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**credits** | [**SubAccountDetailsResponsePlanInfoCredits**](SubAccountDetailsResponsePlanInfoCredits.md) |  | [optional] 
+**features** | [**SubAccountDetailsResponsePlanInfoFeatures**](SubAccountDetailsResponsePlanInfoFeatures.md) |  | [optional] 
+**plan_type** | **String** | type of the plan | [optional] 
+
+

data/docs/SubAccountDetailsResponsePlanInfoCredits.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SubAccountDetailsResponsePlanInfoCredits
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sms** | **Integer** | SMS credits remaining on the sub-account | [optional] 
+**emails** | [**SubAccountDetailsResponsePlanInfoCreditsEmails**](SubAccountDetailsResponsePlanInfoCreditsEmails.md) |  | [optional] 
+
+

data/docs/SubAccountDetailsResponsePlanInfoCreditsEmails.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SubAccountDetailsResponsePlanInfoCreditsEmails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quantity** | **Integer** | Quantity of email messaging limits provided | [optional] 
+**remaining** | **Integer** | Available email messaging limits for use | [optional] 
+
+

data/docs/SubAccountDetailsResponsePlanInfoFeatures.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::SubAccountDetailsResponsePlanInfoFeatures
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**inbox** | [**SubAccountDetailsResponsePlanInfoFeaturesInbox**](SubAccountDetailsResponsePlanInfoFeaturesInbox.md) |  | [optional] 
+**landing_page** | [**SubAccountDetailsResponsePlanInfoFeaturesLandingPage**](SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md) |  | [optional] 
+**users** | [**SubAccountDetailsResponsePlanInfoFeaturesUsers**](SubAccountDetailsResponsePlanInfoFeaturesUsers.md) |  | [optional] 
+
+

data/docs/SubAccountDetailsResponsePlanInfoFeaturesInbox.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SubAccountDetailsResponsePlanInfoFeaturesInbox
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quantity** | **Integer** | Quantity of inbox provided | [optional] 
+**remaining** | **Integer** | Available inboxes for use | [optional] 
+
+

data/docs/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SubAccountDetailsResponsePlanInfoFeaturesLandingPage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quantity** | **Integer** | Quantity of landing pages provided | [optional] 
+**remaining** | **Integer** | Available landing pages for use | [optional] 
+
+

data/docs/SubAccountDetailsResponsePlanInfoFeaturesUsers.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SubAccountDetailsResponsePlanInfoFeaturesUsers
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quantity** | **Integer** | Quantity of multi-account's provided | [optional] 
+**remaining** | **Integer** | Available multi-accounts for use | [optional] 
+
+

data/docs/SubAccountUpdatePlanRequest.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SubAccountUpdatePlanRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**credits** | [**SubAccountUpdatePlanRequestCredits**](SubAccountUpdatePlanRequestCredits.md) |  | [optional] 
+**features** | [**SubAccountUpdatePlanRequestFeatures**](SubAccountUpdatePlanRequestFeatures.md) |  | [optional] 
+
+

data/docs/SubAccountUpdatePlanRequestCredits.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::SubAccountUpdatePlanRequestCredits
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **Integer** | Number of email credits | [optional] 
+
+

data/docs/SubAccountUpdatePlanRequestFeatures.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::SubAccountUpdatePlanRequestFeatures
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**users** | **Integer** | Number of multi-users | [optional] 
+**landing_page** | **Integer** | Number of landing pages | [optional] 
+**inbox** | **Integer** | Number of inboxes | [optional] 
+
+

data/docs/SubAccountsResponse.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SubAccountsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** | Total number of subaccounts | [optional] 
+**sub_accounts** | [**Array<SubAccountsResponseSubAccounts>**](SubAccountsResponseSubAccounts.md) |  | [optional] 
+
+

data/docs/SubAccountsResponseSubAccounts.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::SubAccountsResponseSubAccounts
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | id of the sub-account | 
+**company_name** | **String** | Name of the sub-account company | 
+**active** | **BOOLEAN** | Whether the sub-account is active or not | 
+**created_at** | **Integer** | Timestamp when the sub-account was created | 
+
+

data/docs/Task.md

@@ -0,0 +1,13 @@
+# SibApiV3Sdk::Task
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique task id | [optional] 
+**task_type_id** | **String** | Id for type of task e.g Call / Email / Meeting etc. | 
+**name** | **String** | Name of task | 
+**contacts_ids** | **Array<Integer>** | Contact ids for contacts linked to this task | [optional] 
+**deals_ids** | **Array<String>** | Deal ids for deals a task is linked to | [optional] 
+**companies_ids** | **Array<String>** | Companies ids for companies a task is linked to | [optional] 
+
+

data/docs/TaskList.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::TaskList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<Task>**](Task.md) | List of tasks | [optional] 
+
+

data/docs/TaskReminder.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::TaskReminder
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Integer** | Value of time unit before reminder is to be sent | 
+**unit** | **String** | Unit of time before reminder is to be sent | 
+**types** | **Array<String>** | Type of task reminder e.g email, push | 
+
+

data/docs/TaskTypes.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::TaskTypes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Id of task type | [optional] 
+**title** | **String** | Title of task type | [optional] 
+
+