sib-api-v3-sdk 8.1.0 → 9.1.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/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

@@ -13,9 +13,11 @@ Name | Type | Description | Notes
 **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, 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] 
-**template_id** | **Integer** | Id of the template. | [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 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/SubAccountDetailsResponsePlanInfoCredits.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sms** | **Integer** | Sms quota of the sub-account | [optional] 
+**sms** | **Integer** | SMS credits remaining on the sub-account | [optional] 
 **emails** | [**SubAccountDetailsResponsePlanInfoCreditsEmails**](SubAccountDetailsResponsePlanInfoCreditsEmails.md) |  | [optional] 
 
 

data/docs/SubAccountsResponseSubAccounts.md

@@ -3,9 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | client id of sub-account organization | 
-**company_name** | **String** | Name of sub-account organization | 
-**active** | **BOOLEAN** | Whether organization is active or not | 
-**created_at** | **Integer** | timestamp when the organization was created | 
+**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

@@ -3,22 +3,11 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**first_contact** | [**Contact**](Contact.md) |  | [optional] 
 **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] 
-**contacts** | [**Array<Contact>**](Contact.md) | Contact details 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] 
-**assign_to_id** | **String** | User id to whom task is assigned | [optional] 
-**date** | **DateTime** | Task date/time | 
-**duration** | **Integer** | Duration of task | [optional] 
-**notes** | **String** | Notes added to a task | [optional] 
-**done** | **BOOLEAN** | Task marked as done | [optional] 
-**reminder** | [**TaskReminder**](TaskReminder.md) | Task reminder date/time for a task | [optional] 
-**created_at** | **DateTime** | Task created date/time | [optional] 
-**updated_at** | **DateTime** | Task update date/time | [optional] 
-**refs** | **Object** |  | [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

@@ -5,6 +5,6 @@ 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 | 
+**types** | **Array<String>** | Type of task reminder e.g email, push | 
 
 

data/docs/TaskTypes.md

@@ -4,7 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | Id of task type | [optional] 
-**icon** | **String** | Icon of task type | [optional] 
 **title** | **String** | Title of task type | [optional]