sib-api-v3-sdk 1.0.0

data/docs/SendEmail.md

@@ -0,0 +1,15 @@
+# SibApiV3Sdk::SendEmail
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email_to** | **Array<String>** | Email addresses of the recipients | 
+**email_bcc** | **Array<String>** | Email addresses of the recipients in bcc | [optional] 
+**email_cc** | **Array<String>** | Email addresses of the recipients in cc | [optional] 
+**reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional] 
+**attachment_url** | **String** | Absolute url of the attachment (no local file). Extension allowed: gif, png, bmp, cgm, jpg, jpeg, tif, tiff, rtf, txt, css, shtml, html, htm, csv, zip, pdf, xml, ods, doc, docx, docm, ics, xls, xlsx, ppt, tar, and ez | [optional] 
+**attachment** | [**Array<SendEmailAttachment>**](SendEmailAttachment.md) | Pass the base64 content of the attachment. Extension allowed: gif, png, bmp, cgm, jpg, jpeg, tif, tiff, rtf, txt, css, shtml, html, htm, csv, zip, pdf, xml, ods, doc, docx, docm, ics, xls, xlsx, ppt, tar, and ez | [optional] 
+**headers** | **Hash<String, String>** |  | [optional] 
+**attributes** | **Hash<String, String>** |  | [optional] 
+
+

data/docs/SendEmailAttachment.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SendEmailAttachment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | **String** | Base64 encoded chunk data of the attachment generated on the fly | [optional] 
+**name** | **String** | Required for content. Name of the attachment | [optional] 
+
+

data/docs/SendReport.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SendReport
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**language** | **String** | Language of email content for campaign report sending. | [optional] [default to "fr"]
+**email** | [**SendReportEmail**](SendReportEmail.md) |  | [optional] 
+
+

data/docs/SendReportEmail.md

@@ -0,0 +1,13 @@
+# SibApiV3Sdk::SendReportEmail
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subject** | **String** | Subject of the email message | [optional] 
+**to** | **Array<String>** | Email addresses of the recipients | [optional] 
+**content_type** | **String** | Type of the message body | [optional] 
+**bcc** | **Array<String>** | Email addresses of the recipients in bcc | [optional] 
+**cc** | **Array<String>** | Email addresses of the recipients in cc | [optional] 
+**body** | **String** | Body of the email message | [optional] 
+
+

data/docs/SendSms.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::SendSms
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reference** | **String** |  | 
+
+

data/docs/SendSmtpEmail.md

@@ -0,0 +1,17 @@
+# SibApiV3Sdk::SendSmtpEmail
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sender** | [**SendSmtpEmailSender**](SendSmtpEmailSender.md) |  | [optional] 
+**to** | [**Array<SendSmtpEmailTo>**](SendSmtpEmailTo.md) | Email addresses and names of the recipients | 
+**bcc** | [**Array<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | Email addresses and names of the recipients in bcc | [optional] 
+**cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | Email addresses and names of the recipients in cc | [optional] 
+**html_content** | **String** | HTML body of the message | 
+**text_content** | **String** | Plain Text body of the message | [optional] 
+**subject** | **String** | Subject of the message | 
+**reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) |  | [optional] 
+**attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment. Name can be used in both cases to define the attachment name. It is mandatory in case of content. Extension allowed: gif, png, bmp, cgm, jpg, jpeg, tif, tiff, rtf, txt, css, shtml, html, htm, csv, zip, pdf, xml, ods, doc, docx, docm, ics, xls, xlsx, ppt, tar, and ez | [optional] 
+**headers** | **Hash<String, String>** |  | [optional] 
+
+

data/docs/SendSmtpEmailAttachment.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::SendSmtpEmailAttachment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | Absolute url of the attachment (no local file). | [optional] 
+**content** | **String** | Base64 encoded chunk data of the attachment generated on the fly | [optional] 
+**name** | **String** | Required for content. Name of the attachment | [optional] 
+
+

data/docs/SendSmtpEmailBcc.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SendSmtpEmailBcc
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email address of the recipient in bcc | 
+**name** | **String** | Name of the recipient in bcc | [optional] 
+
+

data/docs/SendSmtpEmailCc.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SendSmtpEmailCc
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email address of the recipient in cc | 
+**name** | **String** | Name of the recipient in cc | [optional] 
+
+

data/docs/SendSmtpEmailReplyTo.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SendSmtpEmailReplyTo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email address in reply to | 
+**name** | **String** | Name in reply to | [optional] 
+
+

data/docs/SendSmtpEmailSender.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SendSmtpEmailSender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Sender Name from which the emails are sent | [optional] 
+**email** | **String** | Sender Email from which the emails are sent | 
+
+

data/docs/SendSmtpEmailTo.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SendSmtpEmailTo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email address of the recipient | 
+**name** | **String** | Name of the recipient | [optional] 
+
+

data/docs/SendTemplateEmail.md

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

data/docs/SendTestEmail.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::SendTestEmail
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email_to** | **Array<String>** | If empty the test email will be sent to your entire test list. Use this field to send it to specific addresses in your list. | [optional] 
+
+

data/docs/SendTestSms.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::SendTestSms
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**phone_numbers** | **Array<String>** | Mobile number with the country code to send test SMS. The mobile number defined here must belong to one of your contacts in SendinBlue account and must not be blacklisted | [optional] 
+
+

data/docs/SendTransacSms.md

@@ -0,0 +1,12 @@
+# SibApiV3Sdk::SendTransacSms
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sender** | **String** | Name of the sender. Only alphanumeric characters. No more than 11 characters | 
+**recipient** | **String** | Mobile number to send SMS with the country code | 
+**content** | **String** | Content of the message. If more than 160 characters long, multiple text messages will be sent | 
+**tag** | **String** | Tag of the message | [optional] 
+**web_url** | **String** | Webhook to call for each event triggered by the message (delivered etc.) | [optional] 
+
+

data/docs/SendersApi.md

@@ -0,0 +1,326 @@
+# SibApiV3Sdk::SendersApi
+
+All URIs are relative to *https://api.sendinblue.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_sender**](SendersApi.md#create_sender) | **POST** /senders | Create a new sender
+[**delete_sender**](SendersApi.md#delete_sender) | **DELETE** /senders/{senderId} | Delete a sender
+[**get_ips**](SendersApi.md#get_ips) | **GET** /senders/ips | Return all the dedicated IPs for your account
+[**get_ips_from_sender**](SendersApi.md#get_ips_from_sender) | **GET** /senders/{senderId}/ips | Return all the dedicated IPs for a sender
+[**get_senders**](SendersApi.md#get_senders) | **GET** /senders | Get the list of all your senders
+[**update_sender**](SendersApi.md#update_sender) | **PUT** /senders/{senderId} | Update a sender
+
+
+# **create_sender**
+> CreateSenderModel create_sender(opts)
+
+Create a new sender
+
+### 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::SendersApi.new
+
+opts = { 
+  sender: SibApiV3Sdk::CreateSender.new # CreateSender | sender's name
+}
+
+begin
+  #Create a new sender
+  result = api_instance.create_sender(opts)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling SendersApi->create_sender: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sender** | [**CreateSender**](CreateSender.md)| sender's name | [optional] 
+
+### Return type
+
+[**CreateSenderModel**](CreateSenderModel.md)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_sender**
+> delete_sender(sender_id)
+
+Delete a sender
+
+### 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::SendersApi.new
+
+sender_id = "sender_id_example" # String | Id of the sender
+
+
+begin
+  #Delete a sender
+  api_instance.delete_sender(sender_id)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling SendersApi->delete_sender: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sender_id** | **String**| Id of the sender | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_ips**
+> GetIps get_ips
+
+Return all the dedicated IPs for your account
+
+### 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::SendersApi.new
+
+begin
+  #Return all the dedicated IPs for your account
+  result = api_instance.get_ips
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling SendersApi->get_ips: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetIps**](GetIps.md)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_ips_from_sender**
+> GetIpsFromSender get_ips_from_sender(sender_id)
+
+Return all the dedicated IPs for a sender
+
+### 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::SendersApi.new
+
+sender_id = "sender_id_example" # String | Id of the sender
+
+
+begin
+  #Return all the dedicated IPs for a sender
+  result = api_instance.get_ips_from_sender(sender_id)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling SendersApi->get_ips_from_sender: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sender_id** | **String**| Id of the sender | 
+
+### Return type
+
+[**GetIpsFromSender**](GetIpsFromSender.md)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_senders**
+> GetSendersList get_senders(opts)
+
+Get the list of all your senders
+
+### 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::SendersApi.new
+
+opts = { 
+  ip: "ip_example", # String | Filter your senders for a specific ip (available for dedicated IP usage only)
+  domain: "domain_example" # String | Filter your senders for a specific domain
+}
+
+begin
+  #Get the list of all your senders
+  result = api_instance.get_senders(opts)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling SendersApi->get_senders: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ip** | **String**| Filter your senders for a specific ip (available for dedicated IP usage only) | [optional] 
+ **domain** | **String**| Filter your senders for a specific domain | [optional] 
+
+### Return type
+
+[**GetSendersList**](GetSendersList.md)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_sender**
+> update_sender(sender_id, opts)
+
+Update a sender
+
+### 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::SendersApi.new
+
+sender_id = "sender_id_example" # String | Id of the sender
+
+opts = { 
+  sender: SibApiV3Sdk::UpdateSender.new # UpdateSender | sender's name
+}
+
+begin
+  #Update a sender
+  api_instance.update_sender(sender_id, opts)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling SendersApi->update_sender: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sender_id** | **String**| Id of the sender | 
+ **sender** | [**UpdateSender**](UpdateSender.md)| sender's name | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+