sib-api-v3-sdk 1.0.0

data/docs/EmailExportRecipients.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::EmailExportRecipients
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**notify_url** | **String** | Webhook called once the export process is finished | [optional] 
+**recipients_type** | **String** | Type of recipients to export for a campaign | 
+
+

data/docs/ErrorModel.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::ErrorModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Error code displayed in case of a failure | 
+**message** | **String** | Readable message associated to the failure | 
+
+

data/docs/FoldersApi.md

@@ -0,0 +1,336 @@
+# SibApiV3Sdk::FoldersApi
+
+All URIs are relative to *https://api.sendinblue.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_folder**](FoldersApi.md#create_folder) | **POST** /contacts/folders | Create a folder
+[**delete_folder**](FoldersApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
+[**get_folder**](FoldersApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns folder details
+[**get_folder_lists**](FoldersApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder
+[**get_folders**](FoldersApi.md#get_folders) | **GET** /contacts/folders | Get all the folders
+[**update_folder**](FoldersApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a contact folder
+
+
+# **create_folder**
+> CreateModel create_folder(name)
+
+Create a folder
+
+### 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'
+end
+
+api_instance = SibApiV3Sdk::FoldersApi.new
+
+name = SibApiV3Sdk::CreaUpdateFolder.new # CreaUpdateFolder | Name of the folder
+
+
+begin
+  #Create a folder
+  result = api_instance.create_folder(name)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling FoldersApi->create_folder: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | [**CreaUpdateFolder**](CreaUpdateFolder.md)| Name of the folder | 
+
+### Return type
+
+[**CreateModel**](CreateModel.md)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_folder**
+> delete_folder(folder_id)
+
+Delete a folder (and all its lists)
+
+### 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'
+end
+
+api_instance = SibApiV3Sdk::FoldersApi.new
+
+folder_id = "folder_id_example" # String | Id of the folder
+
+
+begin
+  #Delete a folder (and all its lists)
+  api_instance.delete_folder(folder_id)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling FoldersApi->delete_folder: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **folder_id** | **String**| Id of the folder | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_folder**
+> GetFolder get_folder(folder_id)
+
+Returns folder 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'
+end
+
+api_instance = SibApiV3Sdk::FoldersApi.new
+
+folder_id = "folder_id_example" # String | id of the folder
+
+
+begin
+  #Returns folder details
+  result = api_instance.get_folder(folder_id)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling FoldersApi->get_folder: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **folder_id** | **String**| id of the folder | 
+
+### Return type
+
+[**GetFolder**](GetFolder.md)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_folder_lists**
+> GetFolderLists get_folder_lists(folder_id, opts)
+
+Get the lists in a folder
+
+### 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'
+end
+
+api_instance = SibApiV3Sdk::FoldersApi.new
+
+folder_id = "folder_id_example" # String | Id of the folder
+
+opts = { 
+  limit: 10, # Integer | Number of documents per page
+  offset: 0 # Integer | Index of the first document of the page
+}
+
+begin
+  #Get the lists in a folder
+  result = api_instance.get_folder_lists(folder_id, opts)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling FoldersApi->get_folder_lists: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **folder_id** | **String**| 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]
+
+### Return type
+
+[**GetFolderLists**](GetFolderLists.md)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_folders**
+> GetFolders get_folders(limit, offset)
+
+Get all the folders
+
+### 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'
+end
+
+api_instance = SibApiV3Sdk::FoldersApi.new
+
+limit = 10 # Integer | Number of documents per page
+
+offset = 0 # Integer | Index of the first document of the page
+
+
+begin
+  #Get all the folders
+  result = api_instance.get_folders(limit, offset)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling FoldersApi->get_folders: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Number of documents per page | [default to 10]
+ **offset** | **Integer**| Index of the first document of the page | [default to 0]
+
+### Return type
+
+[**GetFolders**](GetFolders.md)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_folder**
+> update_folder(folder_id, name)
+
+Update a contact folder
+
+### 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'
+end
+
+api_instance = SibApiV3Sdk::FoldersApi.new
+
+folder_id = "folder_id_example" # String | Id of the folder
+
+name = SibApiV3Sdk::CreaUpdateFolder.new # CreaUpdateFolder | Name of the folder
+
+
+begin
+  #Update a contact folder
+  api_instance.update_folder(folder_id, name)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling FoldersApi->update_folder: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **folder_id** | **String**| Id of the folder | 
+ **name** | [**CreaUpdateFolder**](CreaUpdateFolder.md)| Name of the folder | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/GetAccount.md

@@ -0,0 +1,15 @@
+# SibApiV3Sdk::GetAccount
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Login Email | 
+**first_name** | **String** | First Name | 
+**last_name** | **String** | Last Name | 
+**company_name** | **String** | Name of the company | 
+**address** | [**GetExtendedClientAddress**](GetExtendedClientAddress.md) |  | [optional] 
+**plan** | [**Array<GetAccountPlan>**](GetAccountPlan.md) | Information about your plans and credits | 
+**relay** | [**GetAccountRelay**](GetAccountRelay.md) |  | [optional] 
+**marketing_automation** | [**GetAccountMarketingAutomation**](GetAccountMarketingAutomation.md) |  | [optional] 
+
+

data/docs/GetAccountMarketingAutomation.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetAccountMarketingAutomation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | Marketing Automation Tracker ID | [optional] 
+**enabled** | **BOOLEAN** | Status of Marketing Automation Plateform activation for your account (true=enabled, false=disabled) | 
+
+

data/docs/GetAccountPlan.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::GetAccountPlan
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Displays the plan type of the user | 
+**credits_type** | **String** | This is the type of the credit, \"User Limit\" or \"Send Limit\" are two possible types of credit of a user. \"User Limit\" implies the total number of subscribers you can add to your account, and \"Send Limit\" implies the total number of emails you can send to the subscribers in your account. | 
+**credits** | **Integer** | Remaining credits of the user. This can either be \"User Limit\" or \"Send Limit\" depending on the plan. | 
+
+

data/docs/GetAccountRelay.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetAccountRelay
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enabled** | **BOOLEAN** | Status of your SMTP Account (true=Enabled, false=Disabled) | 
+**data** | [**GetAccountRelayData**](GetAccountRelayData.md) |  | [optional] 
+
+

data/docs/GetAccountRelayData.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::GetAccountRelayData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_name** | **String** | Email to use as login on SMTP | 
+**relay** | **String** | URL of the SMTP Relay | 
+**port** | **Integer** | Port used for SMTP Relay | 
+
+

data/docs/GetAggregatedReport.md

@@ -0,0 +1,19 @@
+# SibApiV3Sdk::GetAggregatedReport
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**range** | **String** | Time frame of the report | 
+**requests** | **Integer** | Number of requests for the timeframe | 
+**delivered** | **Integer** | Number of delivered emails for the timeframe | 
+**hard_bounces** | **Integer** | Number of hardbounces for the timeframe | 
+**soft_bounces** | **Integer** | Number of softbounces for the timeframe | 
+**clicks** | **Integer** | Number of clicks for the timeframe | 
+**unique_clicks** | **Integer** | Number of unique clicks for the timeframe | 
+**opens** | **Integer** | Number of openings for the timeframe | 
+**unique_opens** | **Integer** | Number of unique openings for the timeframe | 
+**spam_reports** | **Integer** | Number of complaint (spam report) for the timeframe | 
+**blocked** | **Integer** | Number of blocked contact emails for the timeframe | 
+**invalid** | **Integer** | Number of invalid emails for the timeframe | 
+
+

data/docs/GetAttributes.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::GetAttributes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attributes** | [**Array<GetAttributesAttributes>**](GetAttributesAttributes.md) | Listing of available contact attributes in your account | 
+
+