sib-api-v3-sdk 1.0.0

data/docs/CreaUpdateFolder.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::CreaUpdateFolder
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the folder | [optional] 
+
+

data/docs/CreateAttribute.md

@@ -0,0 +1,12 @@
+# SibApiV3Sdk::CreateAttribute
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**category** | **String** | Attribute categorisation. | 
+**name** | **String** | Name of the attribute | 
+**value** | **String** | Value of the attribute | 
+**enumemaration** | [**Array<CreateAttributeEnumemaration>**](CreateAttributeEnumemaration.md) | Values that the attribute can take. Use only if the attribute's category is category | [optional] 
+**type** | **String** | Type of the attribute | [optional] 
+
+

data/docs/CreateAttributeEnumemaration.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::CreateAttributeEnumemaration
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Id of the value | [optional] 
+**label** | **String** | Label of the value | [optional] 
+
+

data/docs/CreateChild.md

@@ -0,0 +1,12 @@
+# SibApiV3Sdk::CreateChild
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email address to create the child account | 
+**first_name** | **String** | First name to use to create the child account | 
+**last_name** | **String** | Last name to use to create the child account | 
+**company_name** | **String** | Company name to use to create the child account | 
+**password** | **String** | Password for the child account to login | 
+
+

data/docs/CreateContact.md

@@ -0,0 +1,12 @@
+# SibApiV3Sdk::CreateContact
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email address of the user. Mandatory if `attributes.sms` is not passed | [optional] 
+**attributes** | **Object** | Values of the attributes to fill. The attributes must exist in you contact database | [optional] 
+**email_blacklisted** | **BOOLEAN** | Blacklist the contact for emails (emailBlacklisted = true) | [optional] 
+**sms_blacklisted** | **BOOLEAN** | Blacklist the contact for SMS (smsBlacklisted = true) | [optional] 
+**list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional] 
+
+

data/docs/CreateEmailCampaign.md

@@ -0,0 +1,25 @@
+# SibApiV3Sdk::CreateEmailCampaign
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag** | **String** | Tag of the campaign | [optional] 
+**sender** | [**CreateEmailCampaignSender**](CreateEmailCampaignSender.md) |  | [optional] 
+**name** | **String** | Name of the campaign | 
+**html_content** | **String** | Mandatory if htmlUrl is empty. Body of the message (HTML) | [optional] 
+**html_url** | **String** | Mandatory if htmlContent is empty. Url to the message (HTML) | [optional] 
+**scheduled_at** | **String** | Sending date and time (YYYY-MM-DD HH:mm:ss) | [optional] 
+**subject** | **String** | Subject of the campaign | 
+**reply_to** | **String** | Email on which the campaign recipients will be able to reply to | [optional] 
+**to_field** | **String** | To personalize the «To» Field, e.g. if you want to include the first name and last name of your recipient, use [FNAME] [LNAME]. These attributes must already exist in your contact database | [optional] 
+**recipients** | [**CreateEmailCampaignRecipients**](CreateEmailCampaignRecipients.md) |  | [optional] 
+**attachment_url** | **String** | Absolute url of the attachment (no local file). Extensions allowed xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff and rtf | [optional] 
+**inline_image_activation** | **BOOLEAN** | Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts | [optional] [default to false]
+**mirror_active** | **BOOLEAN** | Use true to enable the mirror link | [optional] 
+**recurring** | **BOOLEAN** | For trigger campagins use false to make sure a contact receives the same campaign only once | [optional] [default to false]
+**type** | **String** | Type of the campaign | 
+**footer** | **String** | Footer of the email campaign | [optional] 
+**header** | **String** | Header of the email campaign | [optional] 
+**utm_campaign** | **String** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional] 
+
+

data/docs/CreateEmailCampaignRecipients.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::CreateEmailCampaignRecipients
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**exclusion_list_ids** | **Array<Integer>** | List ids to exclude from the campaign | [optional] 
+**list_ids** | **Array<Integer>** | Mandatory if scheduledAt is not empty. List Ids to send the campaign to | [optional] 
+
+

data/docs/CreateEmailCampaignSender.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::CreateEmailCampaignSender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Sender Name | [optional] 
+**email** | **String** | Sender email | 
+
+

data/docs/CreateList.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::CreateList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the list | 
+**folder_id** | **Integer** | Id of the folder in which to create the list | 
+
+

data/docs/CreateModel.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::CreateModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the object created | 
+
+

data/docs/CreateSender.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::CreateSender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | From Name to use for the sender | 
+**email** | **String** | From Email to use for the sender | 
+**ips** | [**Array<CreateSenderIps>**](CreateSenderIps.md) | Mandatory in case of dedicated IP, IPs to associate to the sender | [optional] 
+
+

data/docs/CreateSenderIps.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::CreateSenderIps
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ip** | **String** | Dedicated IP available in your account | 
+**domain** | **String** | Domain of the IP | 
+**weight** | **Integer** | Weight to apply to the IP. Sum of all IP weights must be 100. Should be passed for either ALL or NONE of the IPs. If it's not passed, the sending will be equally balanced on all IPs. | [optional] 
+
+

data/docs/CreateSenderModel.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::CreateSenderModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the Sender created | 
+**spf_error** | **BOOLEAN** | Status of SPF configuration for the sender (true = SPF not well configured, false = SPF well configured) | [optional] 
+**dkim_error** | **BOOLEAN** | Status of DKIM configuration for the sender (true = DKIM not well configured, false = DKIM well configured) | [optional] 
+
+

data/docs/CreateSmsCampaign.md

@@ -0,0 +1,12 @@
+# SibApiV3Sdk::CreateSmsCampaign
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the campaign | 
+**sender** | **String** | Name of the sender. The number of characters is limited to 11 | 
+**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** | Date and time on which the campaign has to run (YYYY-MM-DD HH:mm:ss) | [optional] 
+
+

data/docs/CreateSmsCampaignRecipients.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::CreateSmsCampaignRecipients
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**list_ids** | **Array<Integer>** | Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty | 
+**exclusion_list_ids** | **Array<Integer>** | List ids which have to be excluded from a campaign | 
+
+

data/docs/CreateSmtpEmail.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::CreateSmtpEmail
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message_id** | **String** | Message ID of the SMTP Email sent | 
+
+

data/docs/CreateSmtpTemplate.md

@@ -0,0 +1,17 @@
+# SibApiV3Sdk::CreateSmtpTemplate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag** | **String** | Tag of the template | [optional] 
+**sender** | [**CreateSmtpTemplateSender**](CreateSmtpTemplateSender.md) |  | [optional] 
+**template_name** | **String** | Name of the template | 
+**html_content** | **String** | Body of the message (HTML version). The field must have more than 10 characters. REQUIRED if htmlUrl is empty | [optional] 
+**html_url** | **String** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional] 
+**subject** | **String** | Subject of the template | 
+**reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional] 
+**to_field** | **String** | This is to personalize the «To» Field. If you want to include the first name and last name of your recipient, add [FNAME] [LNAME]. To use the contact attributes here, these must already exist in SendinBlue account | [optional] 
+**attachment_url** | **String** | Absolute url of the attachment (no local file). Extensions allowed xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff and rtf | [optional] 
+**is_active** | **BOOLEAN** | Status of template. isActive = true means template is active and isActive = false means template is inactive | [optional] 
+
+

data/docs/CreateSmtpTemplateSender.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::CreateSmtpTemplateSender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the sender. If not passed, will be set to default | [optional] 
+**email** | **String** | Email of the sender | 
+
+

data/docs/CreateWebhook.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::CreateWebhook
+
+## Properties
+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 – 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 | [optional] 
+**type** | **String** | Type of the webhook | [optional] [default to "transactional"]
+
+

data/docs/CreatedProcessId.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::CreatedProcessId
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**process_id** | **Integer** | Id of the process created | 
+
+

data/docs/DeleteHardbounces.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::DeleteHardbounces
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start_date** | **Date** | Starting date (YYYY-MM-DD) of the period from which the hardbounces will be deleted. Must be lower than equal to endDate | [optional] 
+**end_date** | **Date** | Ending date (YYYY-MM-DD) of the period from which the hardbounces will be deleted. Must be greater than equal to startDate | [optional] 
+**contact_email** | **String** | Target a specific email address | [optional] 
+
+

data/docs/EmailCampaignsApi.md

@@ -0,0 +1,557 @@
+# SibApiV3Sdk::EmailCampaignsApi
+
+All URIs are relative to *https://api.sendinblue.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_email_campaign**](EmailCampaignsApi.md#create_email_campaign) | **POST** /emailCampaigns | Create an email campaign
+[**delete_email_campaigns**](EmailCampaignsApi.md#delete_email_campaigns) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
+[**email_export_recipients**](EmailCampaignsApi.md#email_export_recipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of a campaign
+[**get_email_campaign**](EmailCampaignsApi.md#get_email_campaign) | **GET** /emailCampaigns/{campaignId} | Get campaign informations
+[**get_email_campaigns**](EmailCampaignsApi.md#get_email_campaigns) | **GET** /emailCampaigns | Return all your created campaigns
+[**send_email_campaign_now**](EmailCampaignsApi.md#send_email_campaign_now) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign id of the campaign immediately
+[**send_report**](EmailCampaignsApi.md#send_report) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaigns
+[**send_test_email**](EmailCampaignsApi.md#send_test_email) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
+[**update_campaign_status**](EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update a campaign status
+[**update_email_campaigns**](EmailCampaignsApi.md#update_email_campaigns) | **PUT** /emailCampaigns/{campaignId} | Update a campaign
+
+
+# **create_email_campaign**
+> CreateModel create_email_campaign(email_campaigns)
+
+Create an email campaign
+
+### 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::EmailCampaignsApi.new
+
+email_campaigns = SibApiV3Sdk::CreateEmailCampaign.new # CreateEmailCampaign | Values to create a campaign
+
+
+begin
+  #Create an email campaign
+  result = api_instance.create_email_campaign(email_campaigns)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling EmailCampaignsApi->create_email_campaign: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_campaigns** | [**CreateEmailCampaign**](CreateEmailCampaign.md)| Values to create a campaign | 
+
+### Return type
+
+[**CreateModel**](CreateModel.md)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_email_campaigns**
+> delete_email_campaigns(campaign_id)
+
+Delete an email campaign
+
+### 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::EmailCampaignsApi.new
+
+campaign_id = "campaign_id_example" # String | id of the campaign
+
+
+begin
+  #Delete an email campaign
+  api_instance.delete_email_campaigns(campaign_id)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling EmailCampaignsApi->delete_email_campaigns: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **campaign_id** | **String**| id of the campaign | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **email_export_recipients**
+> CreatedProcessId email_export_recipients(campaign_id, opts)
+
+Export the recipients of a campaign
+
+### 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::EmailCampaignsApi.new
+
+campaign_id = "campaign_id_example" # String | Id of the campaign
+
+opts = { 
+  recipient_export: SibApiV3Sdk::EmailExportRecipients.new # EmailExportRecipients | Values to send for a recipient export request
+}
+
+begin
+  #Export the recipients of a campaign
+  result = api_instance.email_export_recipients(campaign_id, opts)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling EmailCampaignsApi->email_export_recipients: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **campaign_id** | **String**| Id of the campaign | 
+ **recipient_export** | [**EmailExportRecipients**](EmailExportRecipients.md)| Values to send for a recipient export request | [optional] 
+
+### Return type
+
+[**CreatedProcessId**](CreatedProcessId.md)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_email_campaign**
+> GetEmailCampaign get_email_campaign(campaign_id)
+
+Get campaign informations
+
+### 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::EmailCampaignsApi.new
+
+campaign_id = "campaign_id_example" # String | Id of the campaign
+
+
+begin
+  #Get campaign informations
+  result = api_instance.get_email_campaign(campaign_id)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling EmailCampaignsApi->get_email_campaign: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **campaign_id** | **String**| Id of the campaign | 
+
+### Return type
+
+[**GetEmailCampaign**](GetEmailCampaign.md)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_email_campaigns**
+> GetEmailCampaigns get_email_campaigns(opts)
+
+Return all your created campaigns
+
+### 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::EmailCampaignsApi.new
+
+opts = { 
+  type: "type_example", # String | Filter on the type of the campaigns
+  status: "status_example", # String | Filter on the status of the campaign
+  limit: 500, # Integer | Number of documents per page
+  offset: 0 # Integer | Index of the first document in the page
+}
+
+begin
+  #Return all your created campaigns
+  result = api_instance.get_email_campaigns(opts)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling EmailCampaignsApi->get_email_campaigns: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **type** | **String**| Filter on the type of the campaigns | [optional] 
+ **status** | **String**| Filter on the status of the campaign | [optional] 
+ **limit** | **Integer**| Number of documents per page | [optional] [default to 500]
+ **offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
+
+### Return type
+
+[**GetEmailCampaigns**](GetEmailCampaigns.md)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **send_email_campaign_now**
+> send_email_campaign_now(campaign_id)
+
+Send an email campaign id of the campaign immediately
+
+### 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::EmailCampaignsApi.new
+
+campaign_id = "campaign_id_example" # String | Id of the campaign
+
+
+begin
+  #Send an email campaign id of the campaign immediately
+  api_instance.send_email_campaign_now(campaign_id)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling EmailCampaignsApi->send_email_campaign_now: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **campaign_id** | **String**| Id of the campaign | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **send_report**
+> send_report(campaign_id, send_report)
+
+Send the report of a campaigns
+
+A PDF will be sent to the specified email addresses
+
+### 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::EmailCampaignsApi.new
+
+campaign_id = "campaign_id_example" # String | Id of the campaign
+
+send_report = SibApiV3Sdk::SendReport.new # SendReport | Values for send a report
+
+
+begin
+  #Send the report of a campaigns
+  api_instance.send_report(campaign_id, send_report)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling EmailCampaignsApi->send_report: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **campaign_id** | **String**| Id of the campaign | 
+ **send_report** | [**SendReport**](SendReport.md)| Values for send a report | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **send_test_email**
+> send_test_email(campaign_id, email_to)
+
+Send an email campaign to your test list
+
+### 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::EmailCampaignsApi.new
+
+campaign_id = "campaign_id_example" # String | Id of the campaign
+
+email_to = SibApiV3Sdk::SendTestEmail.new # SendTestEmail | 
+
+
+begin
+  #Send an email campaign to your test list
+  api_instance.send_test_email(campaign_id, email_to)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling EmailCampaignsApi->send_test_email: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **campaign_id** | **String**| Id of the campaign | 
+ **email_to** | [**SendTestEmail**](SendTestEmail.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_campaign_status**
+> update_campaign_status(campaign_id, status)
+
+Update a campaign status
+
+### 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::EmailCampaignsApi.new
+
+campaign_id = "campaign_id_example" # String | Id of the campaign
+
+status = SibApiV3Sdk::UpdateCampaignStatus.new # UpdateCampaignStatus | Status of the campaign
+
+
+begin
+  #Update a campaign status
+  api_instance.update_campaign_status(campaign_id, status)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling EmailCampaignsApi->update_campaign_status: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **campaign_id** | **String**| Id of the campaign | 
+ **status** | [**UpdateCampaignStatus**](UpdateCampaignStatus.md)| Status of the campaign | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_email_campaigns**
+> update_email_campaigns(campaign_id, email_campaign)
+
+Update a campaign
+
+### 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::EmailCampaignsApi.new
+
+campaign_id = "campaign_id_example" # String | Id of the campaign
+
+email_campaign = SibApiV3Sdk::UpdateEmailCampaign.new # UpdateEmailCampaign | Values to update a campaign
+
+
+begin
+  #Update a campaign
+  api_instance.update_email_campaigns(campaign_id, email_campaign)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling EmailCampaignsApi->update_email_campaigns: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **campaign_id** | **String**| Id of the campaign | 
+ **email_campaign** | [**UpdateEmailCampaign**](UpdateEmailCampaign.md)| Values to update a campaign | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+