sib-api-v3-sdk 7.5.0 → 8.0.0

data/docs/SubAccountsResponseSubAccounts.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::SubAccountsResponseSubAccounts
+
+## 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 | 
+
+

data/docs/Task.md

@@ -0,0 +1,24 @@
+# SibApiV3Sdk::Task
+
+## 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/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 | 
+
+

data/docs/TransactionalEmailsApi.md

@@ -18,7 +18,6 @@ Method | HTTP request | Description
 [**get_transac_blocked_contacts**](TransactionalEmailsApi.md#get_transac_blocked_contacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
 [**get_transac_email_content**](TransactionalEmailsApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
 [**get_transac_emails_list**](TransactionalEmailsApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
-[**send_template**](TransactionalEmailsApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
 [**send_test_template**](TransactionalEmailsApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
 [**send_transac_email**](TransactionalEmailsApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
 [**smtp_blocked_contacts_email_delete**](TransactionalEmailsApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
@@ -319,6 +318,8 @@ nil (empty response body)
 
 Get your transactional email activity aggregated over a period of time
 
+This endpoint will show the aggregated stats for past 90 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days
+
 ### Example
 ```ruby
 # load the gem
@@ -436,6 +437,8 @@ This endpoint does not need any parameter.
 
 Get all your transactional email activity (unaggregated events)
 
+This endpoint will show the aggregated stats for past 30 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days
+
 ### Example
 ```ruby
 # load the gem
@@ -899,68 +902,6 @@ Name | Type | Description  | Notes
 
 
 
-# **send_template**
-> SendTemplateEmail send_template(template_id, send_email)
-
-Send a template
-
-This endpoint is deprecated. Prefer v3/smtp/email instead.
-
-### 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
-
-template_id = 789 # Integer | Id of the template
-
-send_email = SibApiV3Sdk::SendEmail.new # SendEmail | 
-
-
-begin
-  #Send a template
-  result = api_instance.send_template(template_id, send_email)
-  p result
-rescue SibApiV3Sdk::ApiError => e
-  puts "Exception when calling TransactionalEmailsApi->send_template: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **template_id** | **Integer**| Id of the template | 
- **send_email** | [**SendEmail**](SendEmail.md)|  | 
-
-### Return type
-
-[**SendTemplateEmail**](SendTemplateEmail.md)
-
-### Authorization
-
-[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
 # **send_test_template**
 > send_test_template(template_id, send_test_email)
 

data/docs/UpdateBatchContacts.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::UpdateBatchContacts
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contacts** | [**Array<UpdateBatchContactsContacts>**](UpdateBatchContactsContacts.md) | List of contacts to be updated | [optional] 
+
+

data/docs/UpdateBatchContactsContacts.md

@@ -0,0 +1,16 @@
+# SibApiV3Sdk::UpdateBatchContactsContacts
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email address of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) | [optional] 
+**id** | **Integer** | id of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) | [optional] 
+**sms** | **String** | SMS of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) | [optional] 
+**attributes** | **Hash<String, 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] 
+**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] 
+**unlink_list_ids** | **Array<Integer>** | Ids of the lists to remove the contact from | [optional] 
+**smtp_blacklist_sender** | **Array<String>** | transactional email forbidden sender for contact. Use only for email Contact | [optional] 
+
+

data/docs/UpdateBatchContactsModel.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::UpdateBatchContactsModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success_ids** | **Array<Integer>** |  | [optional] 
+**failure_ids** | **Array<Integer>** |  | [optional] 
+
+

data/docs/UpdateSmsCampaign.md

@@ -8,5 +8,6 @@ Name | Type | Description | Notes
 **content** | **String** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS | [optional] 
 **recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) |  | [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. | [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/UpdateWebhook.md

@@ -5,6 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **url** | **String** | URL of the webhook | [optional] 
 **description** | **String** | Description of the webhook | [optional] 
-**events** | **Array<String>** | Events triggering the webhook. Possible values for Transactional type webhook – `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` and possible values for Marketing type webhook – `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` and `delivered` | [optional] 
+**events** | **Array<String>** | - Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed`  | [optional] 
+**domain** | **String** | Inbound domain of webhook, used in case of event type `inbound` | [optional] 
 
 

data/lib/sib-api-v3-sdk/api/contacts_api.rb

@@ -622,6 +622,7 @@ module SibApiV3Sdk
       return data, status_code, headers
     end
     # Get a contact's details
+    # Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats (https://developers.sendinblue.com/reference/contacts-7#getcontactstats) endpoint with the appropriate date ranges.
     # @param identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value
     # @param [Hash] opts the optional parameters
     # @return [GetExtendedContactDetails]
@@ -631,6 +632,7 @@ module SibApiV3Sdk
     end
 
     # Get a contact's details
+    # Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats (https://developers.sendinblue.com/reference/contacts-7#getcontactstats) endpoint with the appropriate date ranges.
     # @param identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value
     # @param [Hash] opts the optional parameters
     # @return [Array<(GetExtendedContactDetails, Fixnum, Hash)>] GetExtendedContactDetails data, response status code and response headers
@@ -677,7 +679,7 @@ module SibApiV3Sdk
     # @param identifier Email (urlencoded) OR ID of the contact
     # @param [Hash] opts the optional parameters
     # @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
-    # @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
+    # @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days
     # @return [GetContactCampaignStats]
     def get_contact_stats(identifier, opts = {})
       data, _status_code, _headers = get_contact_stats_with_http_info(identifier, opts)
@@ -688,7 +690,7 @@ module SibApiV3Sdk
     # @param identifier Email (urlencoded) OR ID of the contact
     # @param [Hash] opts the optional parameters
     # @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
-    # @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
+    # @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days
     # @return [Array<(GetContactCampaignStats, Fixnum, Hash)>] GetContactCampaignStats data, response status code and response headers
     def get_contact_stats_with_http_info(identifier, opts = {})
       if @api_client.config.debugging
@@ -1404,6 +1406,57 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
+    # Update multiple contacts
+    # @param update_batch_contacts Values to update multiple contacts
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def update_batch_contacts(update_batch_contacts, opts = {})
+      update_batch_contacts_with_http_info(update_batch_contacts, opts)
+      nil
+    end
+
+    # Update multiple contacts
+    # @param update_batch_contacts Values to update multiple contacts
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def update_batch_contacts_with_http_info(update_batch_contacts, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ContactsApi.update_batch_contacts ...'
+      end
+      # verify the required parameter 'update_batch_contacts' is set
+      if @api_client.config.client_side_validation && update_batch_contacts.nil?
+        fail ArgumentError, "Missing the required parameter 'update_batch_contacts' when calling ContactsApi.update_batch_contacts"
+      end
+      # resource path
+      local_var_path = '/contacts/batch'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(update_batch_contacts)
+      auth_names = ['api-key', 'partner-key']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ContactsApi#update_batch_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Update a contact
     # @param identifier Email (urlencoded) OR ID of the contact
     # @param update_contact Values to update a contact