sib-api-v3-sdk 7.4.0 → 8.1.0

data/docs/Contact.md

@@ -0,0 +1,15 @@
+# SibApiV3Sdk::Contact
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**virtual_next_task** | **Object** | Next incomplete task of contact | [optional] 
+**email** | **String** | Contact email | 
+**assign_to_id** | **String** | User id to whom contact is assigned | [optional] 
+**contacts_id** | **Integer** | Contact id | [optional] 
+**crm_lists** | **Object** | CRM lists in which contact is added | 
+**attributes** | **Object** | Contact attributes e.g firstname / lastname / SMS etc. | [optional] 
+**created_at** | **DateTime** | Contact created date/time | [optional] 
+**updated_at** | **DateTime** | Contact updated date/time | [optional] 
+
+

data/docs/ContactsApi.md

@@ -28,6 +28,7 @@ Method | HTTP request | Description
 [**remove_contact_from_list**](ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
 [**request_contact_export**](ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
 [**update_attribute**](ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
+[**update_batch_contacts**](ContactsApi.md#update_batch_contacts) | **POST** /contacts/batch | Update multiple contacts
 [**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{identifier} | Update a contact
 [**update_folder**](ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
 [**update_list**](ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
@@ -665,6 +666,8 @@ This endpoint does not need any parameter.
 
 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.
+
 ### Example
 ```ruby
 # load the gem
@@ -744,8 +747,8 @@ api_instance = SibApiV3Sdk::ContactsApi.new
 identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact
 
 opts = { 
-  start_date: Date.parse('2013-10-20'), # 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
-  end_date: Date.parse('2013-10-20') # 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
+  start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
+  end_date: 'end_date_example' # String | 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
 }
 
 begin
@@ -762,8 +765,8 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **identifier** | **String**| Email (urlencoded) OR ID of the contact | 
- **start_date** | **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 | [optional] 
- **end_date** | **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 | [optional] 
+ **start_date** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional] 
+ **end_date** | **String**| 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 | [optional] 
 
 ### Return type
 
@@ -1456,6 +1459,62 @@ nil (empty response body)
 
 
 
+# **update_batch_contacts**
+> update_batch_contacts(update_batch_contacts)
+
+Update multiple contacts
+
+### 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::ContactsApi.new
+
+update_batch_contacts = SibApiV3Sdk::UpdateBatchContacts.new # UpdateBatchContacts | Values to update multiple contacts
+
+
+begin
+  #Update multiple contacts
+  api_instance.update_batch_contacts(update_batch_contacts)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling ContactsApi->update_batch_contacts: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **update_batch_contacts** | [**UpdateBatchContacts**](UpdateBatchContacts.md)| Values to update multiple contacts | 
+
+### 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
+
+
+
 # **update_contact**
 > update_contact(identifier, update_contact)
 

data/docs/CreateSmsCampaign.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 | 
 **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/CreateSubAccount.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::CreateSubAccount
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**company_name** | **String** | Name of the organization | 
+**email** | **String** | Email address for the organization | 
+**language** | **String** | Language for identifying localization information | [optional] 
+**timezone** | **String** | Request timezone of the client | [optional] 
+
+

data/docs/CreateWebhook.md

@@ -5,7 +5,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **url** | **String** | URL of the webhook | 
 **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` & `delivered` | 
+**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`  | 
 **type** | **String** | Type of the webhook | [optional] [default to 'transactional']
+**domain** | **String** | Inbound domain of webhook, required in case of event type `inbound` | [optional] 
 
 

data/docs/FileData.md

@@ -0,0 +1,17 @@
+# SibApiV3Sdk::FileData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | Url of uploaded file | [optional] 
+**id** | **String** | Id of uploaded file | [optional] 
+**name** | **String** | Name of uploaded file | [optional] 
+**author_id** | **String** | Account id of user which created the file | [optional] 
+**author** | **Object** | Account details of user which created the file | [optional] 
+**contact_id** | **Integer** | Contact id of contact on which file is uploaded | [optional] 
+**deal_ids** | **Array<String>** | Deal ids linked to a file | [optional] 
+**size** | **Integer** | Size of file uploaded | [optional] 
+**created_at** | **DateTime** | File created date/time | [optional] 
+**updated_at** | **DateTime** | File updated date/time | [optional] 
+
+

data/docs/GetCampaignStats.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **soft_bounces** | **Integer** | Number of softbounce for the campaign | 
 **hard_bounces** | **Integer** | Number of harbounce for the campaign | 
 **unique_views** | **Integer** | Number of unique openings for the campaign | 
+**trackable_views** | **Integer** | Recipients without any privacy protection option enabled in their email client | 
 **unsubscriptions** | **Integer** | Number of unsubscription for the campaign | 
 **viewed** | **Integer** | Number of openings for the campaign | 
 **deferred** | **Integer** | Number of deferred emails for the campaign | [optional] 

data/docs/GetContactCampaignStats.md

@@ -11,5 +11,6 @@ Name | Type | Description | Notes
 **opened** | [**Array<GetContactCampaignStatsOpened>**](GetContactCampaignStatsOpened.md) |  | [optional] 
 **clicked** | [**Array<GetContactCampaignStatsClicked>**](GetContactCampaignStatsClicked.md) |  | [optional] 
 **transac_attributes** | [**Array<GetContactCampaignStatsTransacAttributes>**](GetContactCampaignStatsTransacAttributes.md) |  | [optional] 
+**delivered** | [**Array<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) |  | [optional] 
 
 

data/docs/GetExtendedContactDetailsStatistics.md

@@ -11,5 +11,6 @@ Name | Type | Description | Notes
 **opened** | [**Array<GetExtendedContactDetailsStatisticsOpened>**](GetExtendedContactDetailsStatisticsOpened.md) | Listing of the openings generated by the contact | [optional] 
 **clicked** | [**Array<GetExtendedContactDetailsStatisticsClicked>**](GetExtendedContactDetailsStatisticsClicked.md) | Listing of the clicks generated by the contact | [optional] 
 **transac_attributes** | **Array<Object>** | Listing of the transactional attributes for the contact | [optional] 
+**delivered** | [**Array<GetExtendedContactDetailsStatisticsDelivered>**](GetExtendedContactDetailsStatisticsDelivered.md) | Listing of the delivered campaign for the contact | [optional] 
 
 

data/docs/GetExtendedContactDetailsStatisticsDelivered.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetExtendedContactDetailsStatisticsDelivered
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign_id** | **Integer** | ID of the campaign which generated the event | 
+**event_time** | **String** | UTC date-time of the event | 
+
+

data/docs/GetExtendedList.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **name** | **String** | Name of the list | 
 **total_blacklisted** | **Integer** | Number of blacklisted contacts in the list | 
 **total_subscribers** | **Integer** | Number of contacts in the list | 
+**unique_subscribers** | **Integer** | Number of unique contacts in the list | 
 **folder_id** | **Integer** | ID of the folder | 
 **created_at** | **String** | Creation UTC date-time of the list (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
 **campaign_stats** | [**Array<GetExtendedListCampaignStats>**](GetExtendedListCampaignStats.md) |  | [optional] 

data/docs/GetInboundEmailEvents.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::GetInboundEmailEvents
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**events** | [**Array<GetInboundEmailEventsEvents>**](GetInboundEmailEventsEvents.md) |  | [optional] 
+
+

data/docs/GetInboundEmailEventsByUuid.md

@@ -0,0 +1,15 @@
+# SibApiV3Sdk::GetInboundEmailEventsByUuid
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**received_at** | **DateTime** | Date when email was received on SMTP relay | [optional] 
+**delivered_at** | **DateTime** | Date when email was delivered successfully to client’s webhook | [optional] 
+**recipient** | **String** | Recipient’s email address | [optional] 
+**sender** | **String** | Sender’s email address | [optional] 
+**message_id** | **String** | Value of the Message-ID header. This will be present only after the processing is done. | [optional] 
+**subject** | **String** | Value of the Subject header. This will be present only after the processing is done.  | [optional] 
+**attachments** | [**Array<GetInboundEmailEventsByUuidAttachments>**](GetInboundEmailEventsByUuidAttachments.md) | List of attachments of the email. This will be present only after the processing is done. | [optional] 
+**logs** | [**Array<GetInboundEmailEventsByUuidLogs>**](GetInboundEmailEventsByUuidLogs.md) | List of events/logs that describe the lifecycle of the email on SIB platform | [optional] 
+
+

data/docs/GetInboundEmailEventsByUuidAttachments.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::GetInboundEmailEventsByUuidAttachments
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | filename specified in the Content-Disposition header of the attachment | [optional] 
+**content_type** | **String** | value of the Content-Type header of the attachment | [optional] 
+**content_id** | **String** | value of the Content-ID header of the attachment. | [optional] 
+**content_length** | **Integer** | size of the attachment in bytes | [optional] 
+
+

data/docs/GetInboundEmailEventsByUuidLogs.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetInboundEmailEventsByUuidLogs
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date** | **DateTime** | Date of the event | [optional] 
+**type** | **String** | Type of the event | [optional] 
+
+

data/docs/GetInboundEmailEventsEvents.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::GetInboundEmailEventsEvents
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **String** | UUID that can be used to fetch additional data | 
+**date** | **DateTime** | Date when email was received on SMTP relay | 
+**sender** | **String** | Sender’s email address | 
+**recipient** | **String** | Recipient’s email address | 
+
+

data/docs/GetList.md

@@ -7,5 +7,6 @@ Name | Type | Description | Notes
 **name** | **String** | Name of the list | 
 **total_blacklisted** | **Integer** | Number of blacklisted contacts in the list | 
 **total_subscribers** | **Integer** | Number of contacts in the list | 
+**unique_subscribers** | **Integer** | Number of unique contacts in the list | 
 
 

data/docs/GetTransacEmailsList.md

@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**count** | **Integer** | Total number of transactional emails available on your account according to the passed filter | [optional] 
 **transactional_emails** | [**Array<GetTransacEmailsListTransactionalEmails>**](GetTransacEmailsListTransactionalEmails.md) |  | [optional] 
 
 

data/docs/InboundParsingApi.md

@@ -0,0 +1,139 @@
+# SibApiV3Sdk::InboundParsingApi
+
+All URIs are relative to *https://api.sendinblue.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_inbound_email_events**](InboundParsingApi.md#get_inbound_email_events) | **GET** /inbound/events | Get the list of all the events for the received emails.
+[**get_inbound_email_events_by_uuid**](InboundParsingApi.md#get_inbound_email_events_by_uuid) | **GET** /inbound/events/{uuid} | Fetch all events history for one particular received email.
+
+
+# **get_inbound_email_events**
+> GetInboundEmailEvents get_inbound_email_events(opts)
+
+Get the list of all the events for the received emails.
+
+This endpoint will show the list of all the events for the received emails.
+
+### 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::InboundParsingApi.new
+
+opts = { 
+  sender: 'sender_example', # String | Email address of the sender.
+  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. Maximum time period that can be selected is one month.
+  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.
+  limit: 100, # Integer | Number of documents returned per page
+  offset: 0, # Integer | Index of the first document on the page
+  sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
+}
+
+begin
+  #Get the list of all the events for the received emails.
+  result = api_instance.get_inbound_email_events(opts)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling InboundParsingApi->get_inbound_email_events: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sender** | **String**| Email address of the sender. | [optional] 
+ **start_date** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. | [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] 
+ **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]
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
+
+### Return type
+
+[**GetInboundEmailEvents**](GetInboundEmailEvents.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_inbound_email_events_by_uuid**
+> GetInboundEmailEventsByUuid get_inbound_email_events_by_uuid(uuid)
+
+Fetch all events history for one particular received email.
+
+This endpoint will show the list of all events history for one particular received email.
+
+### 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::InboundParsingApi.new
+
+uuid = 'uuid_example' # String | UUID to fetch events specific to recieved email
+
+
+begin
+  #Fetch all events history for one particular received email.
+  result = api_instance.get_inbound_email_events_by_uuid(uuid)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling InboundParsingApi->get_inbound_email_events_by_uuid: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**| UUID to fetch events specific to recieved email | 
+
+### Return type
+
+[**GetInboundEmailEventsByUuid**](GetInboundEmailEventsByUuid.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+