sib-api-v3-sdk 8.1.0 → 9.0.0

data/docs/FilesApi.md

@@ -0,0 +1,318 @@
+# SibApiV3Sdk::FilesApi
+
+All URIs are relative to *https://api.sendinblue.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**crm_files_get**](FilesApi.md#crm_files_get) | **GET** /crm/files | Get all files
+[**crm_files_id_data_get**](FilesApi.md#crm_files_id_data_get) | **GET** /crm/files/{id}/data | Get file details
+[**crm_files_id_delete**](FilesApi.md#crm_files_id_delete) | **DELETE** /crm/files/{id} | Delete a file
+[**crm_files_id_get**](FilesApi.md#crm_files_id_get) | **GET** /crm/files/{id} | Download a file
+[**crm_files_post**](FilesApi.md#crm_files_post) | **POST** /crm/files | Upload a file
+
+
+# **crm_files_get**
+> FileList crm_files_get(opts)
+
+Get all files
+
+### 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::FilesApi.new
+
+opts = { 
+  entity: 'entity_example', # String | Filter by file entity type
+  entity_ids: 'entity_ids_example', # String | Filter by file 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 files
+  result = api_instance.crm_files_get(opts)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling FilesApi->crm_files_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **entity** | **String**| Filter by file entity type | [optional] 
+ **entity_ids** | **String**| Filter by file 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
+
+[**FileList**](FileList.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_files_id_data_get**
+> FileData crm_files_id_data_get(id)
+
+Get file details
+
+### 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::FilesApi.new
+
+id = 'id_example' # String | File id to get file data.
+
+
+begin
+  #Get file details
+  result = api_instance.crm_files_id_data_get(id)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling FilesApi->crm_files_id_data_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| File id to get file data. | 
+
+### Return type
+
+[**FileData**](FileData.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_files_id_delete**
+> crm_files_id_delete(id)
+
+Delete a file
+
+### 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::FilesApi.new
+
+id = 'id_example' # String | File id to delete.
+
+
+begin
+  #Delete a file
+  api_instance.crm_files_id_delete(id)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling FilesApi->crm_files_id_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| File 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_files_id_get**
+> FileDownloadableLink crm_files_id_get(id)
+
+Download a file
+
+### 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::FilesApi.new
+
+id = 'id_example' # String | File id to download.
+
+
+begin
+  #Download a file
+  result = api_instance.crm_files_id_get(id)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling FilesApi->crm_files_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| File id to download. | 
+
+### Return type
+
+[**FileDownloadableLink**](FileDownloadableLink.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_files_post**
+> FileData crm_files_post(file, opts)
+
+Upload a file
+
+### 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::FilesApi.new
+
+file = File.new('/path/to/file.txt') # File | File data to create a file.
+
+opts = { 
+  deal_id: 'deal_id_example', # String | Deal id linked to a file
+  contact_id: 789, # Integer | Contact id linked to a file
+  company_id: 'company_id_example' # String | Company id linked to a file
+}
+
+begin
+  #Upload a file
+  result = api_instance.crm_files_post(file, opts)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling FilesApi->crm_files_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file** | **File**| File data to create a file. | 
+ **deal_id** | **String**| Deal id linked to a file | [optional] 
+ **contact_id** | **Integer**| Contact id linked to a file | [optional] 
+ **company_id** | **String**| Company id linked to a file | [optional] 
+
+### Return type
+
+[**FileData**](FileData.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+

data/docs/GetCampaignStats.md

@@ -13,6 +13,8 @@ Name | Type | Description | Notes
 **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 | 
+**trackable_views_rate** | **Float** | Rate of recipients without any privacy protection option enabled in their email client | [optional] 
+**estimated_views** | **Integer** | Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails | [optional] 
 **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/GetScheduledEmailByBatchId.md

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

data/docs/GetScheduledEmailByBatchIdBatches.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::GetScheduledEmailByBatchIdBatches
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**scheduled_at** | **DateTime** | Datetime for which the batch was scheduled | 
+**created_at** | **DateTime** | Datetime on which the batch was scheduled | 
+**status** | **String** | Current status of the scheduled batch | 
+
+

data/docs/GetScheduledEmailByMessageId.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::GetScheduledEmailByMessageId
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**scheduled_at** | **DateTime** | Datetime for which the email was scheduled | 
+**created_at** | **DateTime** | Datetime on which the email was scheduled | 
+**status** | **String** | Current status of the scheduled email | 
+
+

data/docs/GetSsoToken.md

@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**token** | **String** | Session token. It will remain valid for a short period of time only. | 
+**token** | **String** | Session token, it will remain valid for 15 days. | 
 
 

data/docs/InboundParsingApi.md

@@ -4,10 +4,70 @@ All URIs are relative to *https://api.sendinblue.com/v3*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**get_inbound_email_attachment**](InboundParsingApi.md#get_inbound_email_attachment) | **GET** /inbound/attachments/{downloadToken} | Retrieve inbound attachment with download token.
 [**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_attachment**
+> File get_inbound_email_attachment(download_token)
+
+Retrieve inbound attachment with download token.
+
+This endpoint will retrieve inbound attachment with download token.
+
+### 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
+
+download_token = 'download_token_example' # String | Token to fetch a particular attachment
+
+
+begin
+  #Retrieve inbound attachment with download token.
+  result = api_instance.get_inbound_email_attachment(download_token)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling InboundParsingApi->get_inbound_email_attachment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **download_token** | **String**| Token to fetch a particular attachment | 
+
+### Return type
+
+**File**
+
+### 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**
 > GetInboundEmailEvents get_inbound_email_events(opts)
 

data/docs/InlineResponse200.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::InlineResponse200
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique company id | 
+
+

data/docs/InlineResponse201.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::InlineResponse201
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique deal id | 
+
+

data/docs/InlineResponse2011.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::InlineResponse2011
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique task id | 
+
+

data/docs/MasterAccountApi.md

@@ -92,7 +92,7 @@ end
 
 api_instance = SibApiV3Sdk::MasterAccountApi.new
 
-offset = 56 # Integer | Page number of sub-accounts listing
+offset = 56 # Integer | Index of the first sub-account in the page
 
 limit = 56 # Integer | Number of sub-accounts to be displayed on each page
 
@@ -110,7 +110,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **offset** | **Integer**| Page number of sub-accounts listing | 
+ **offset** | **Integer**| Index of the first sub-account in the page | 
  **limit** | **Integer**| Number of sub-accounts to be displayed on each page | 
 
 ### Return type
@@ -189,7 +189,7 @@ nil (empty response body)
 
 Get sub-account details
 
-This endpoint will provide the details of specified sub-account organization
+This endpoint will provide the details for the specified sub-account company
 
 ### Example
 ```ruby
@@ -305,7 +305,7 @@ nil (empty response body)
 
 
 # **corporate_sub_account_post**
-> CreateModel corporate_sub_account_post(sub_account_create)
+> CreateSubAccountResponse corporate_sub_account_post(sub_account_create)
 
 Create a new sub-account under a master account.
 
@@ -350,7 +350,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**CreateModel**](CreateModel.md)
+[**CreateSubAccountResponse**](CreateSubAccountResponse.md)
 
 ### Authorization
 
@@ -368,7 +368,7 @@ Name | Type | Description  | Notes
 
 Generate SSO token to access Sendinblue
 
-This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced with actual token.
+This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token.
 
 ### Example
 ```ruby

data/docs/NoteId.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::NoteId
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique note Id | [optional] 
+
+

data/docs/NoteList.md

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