sib-api-v3-sdk 7.2.0 → 8.0.0

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/GetSmsCampaign.md

@@ -7,11 +7,11 @@ Name | Type | Description | Notes
 **name** | **String** | Name of the SMS Campaign | 
 **status** | **String** | Status of the SMS Campaign | 
 **content** | **String** | Content of the SMS Campaign | 
-**scheduled_at** | **DateTime** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional] 
+**scheduled_at** | **String** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional] 
 **sender** | **String** | Sender of the SMS Campaign | 
-**created_at** | **DateTime** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
-**modified_at** | **DateTime** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
-**recipients** | **Object** |  | 
-**statistics** | **Object** |  | 
+**created_at** | **String** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
+**modified_at** | **String** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
+**recipients** | [**GetSmsCampaignRecipients**](GetSmsCampaignRecipients.md) |  | 
+**statistics** | [**GetSmsCampaignRecipients**](GetSmsCampaignRecipients.md) |  | 
 
 

data/docs/GetSmsCampaignOverview.md

@@ -7,9 +7,9 @@ Name | Type | Description | Notes
 **name** | **String** | Name of the SMS Campaign | 
 **status** | **String** | Status of the SMS Campaign | 
 **content** | **String** | Content of the SMS Campaign | 
-**scheduled_at** | **DateTime** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional] 
+**scheduled_at** | **String** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional] 
 **sender** | **String** | Sender of the SMS Campaign | 
-**created_at** | **DateTime** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
-**modified_at** | **DateTime** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
+**created_at** | **String** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
+**modified_at** | **String** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
 
 

data/docs/GetSmsCampaignRecipients.md

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

data/docs/GetSmsEventReportEvents.md

@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **phone_number** | **String** | Phone number which has generated the event | [optional] 
-**date** | **DateTime** | UTC date-time on which the event has been generated | [optional] 
+**date** | **String** | UTC date-time on which the event has been generated | [optional] 
 **message_id** | **String** | Message ID which generated the event | [optional] 
 **event** | **String** | Event which occurred | [optional] 
 **reason** | **String** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional] 

data/docs/GetSmtpTemplateOverview.md

@@ -13,8 +13,8 @@ Name | Type | Description | Notes
 **to_field** | **String** | Customisation of the \"to\" field for the template | 
 **tag** | **String** | Tag of the template | 
 **html_content** | **String** | HTML content of the template | 
-**created_at** | **DateTime** | Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
-**modified_at** | **DateTime** | Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
+**created_at** | **String** | Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
+**modified_at** | **String** | Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
 **doi_template** | **BOOLEAN** | It is true if template is a valid Double opt-in (DOI) template, otherwise it is false. This field will be available only in case of single template detail call. | [optional] 
 
 

data/docs/GetTransacBlockedContactsContacts.md

@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 **email** | **String** | Email address of the blocked or unsubscribed contact | 
 **sender_email** | **String** | Sender email address of the blocked or unsubscribed contact | 
 **reason** | [**GetTransacBlockedContactsReason**](GetTransacBlockedContactsReason.md) |  | 
-**blocked_at** | **DateTime** | Date when the contact was blocked or unsubscribed on | 
+**blocked_at** | **String** | Date when the contact was blocked or unsubscribed on | 
 
 

data/docs/GetTransacEmailContent.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 **email** | **String** | Email address to which transactional email has been sent | 
 **subject** | **String** | Subject of the sent email | 
 **template_id** | **Integer** | Id of the template | [optional] 
-**date** | **DateTime** | Date on which transactional email was sent | 
+**date** | **String** | Date on which transactional email was sent | 
 **events** | [**Array<GetTransacEmailContentEvents>**](GetTransacEmailContentEvents.md) | Series of events which occurred on the transactional email | 
 **body** | **String** | Actual content of the transactional email that has been sent | 
 **attachment_count** | **Integer** | Count of the attachments that were sent in the email | 

data/docs/GetTransacEmailContentEvents.md

@@ -4,6 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Name of the event that occurred on the sent email | 
-**time** | **DateTime** | Time at which the event occurred | 
+**time** | **String** | Time at which the event occurred | 
 
 

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/GetTransacEmailsListTransactionalEmails.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **template_id** | **Integer** | Id of the template | [optional] 
 **message_id** | **String** | Message Id of the sent email | 
 **uuid** | **String** | Unique id of the email sent to a particular contact | 
-**date** | **DateTime** | Date on which transactional email was sent | 
+**date** | **String** | Date on which transactional email was sent | 
 **from** | **String** | Email address of the sender from which the email was sent | [optional] 
 **tags** | **Array<String>** | Tags used for your email | [optional] 
 

data/docs/GetWebhook.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **description** | **String** | Description of the webhook | 
 **events** | **Array<String>** |  | 
 **type** | **String** | Type of webhook (marketing or transac) | 
-**created_at** | **DateTime** | Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
-**modified_at** | **DateTime** | Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
+**created_at** | **String** | Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
+**modified_at** | **String** | Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
 
 

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
+
+
+

data/docs/ListsApi.md

@@ -215,10 +215,10 @@ api_instance = SibApiV3Sdk::ListsApi.new
 list_id = 789 # Integer | Id of the list
 
 opts = { 
-  modified_since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 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.
+  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
+  sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
 }
 
 begin
@@ -235,10 +235,10 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **list_id** | **Integer**| Id of the list | 
- **modified_since** | **DateTime**| 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] 
+ **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 | [optional] [default to desc]
+ **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]
 
 ### Return type
 
@@ -284,7 +284,7 @@ folder_id = 789 # Integer | Id of the folder
 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
+  sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
 }
 
 begin
@@ -303,7 +303,7 @@ 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 | [optional] [default to desc]
+ **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]
 
 ### Return type
 
@@ -404,7 +404,7 @@ api_instance = SibApiV3Sdk::ListsApi.new
 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
+  sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
 }
 
 begin
@@ -422,7 +422,7 @@ 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 | [optional] [default to desc]
+ **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]
 
 ### Return type