sib-api-v3-sdk 5.2.4 → 5.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +13 -7
- data/docs/CreateContact.md +1 -1
- data/docs/CreateEmailCampaign.md +1 -1
- data/docs/CreateSmtpEmail.md +1 -1
- data/docs/GetAccountRelay.md +1 -1
- data/docs/GetAccountRelayData.md +1 -1
- data/docs/GetSmtpTemplates.md +1 -1
- data/docs/GetTransacEmailContent.md +14 -0
- data/docs/GetTransacEmailContentEvents.md +9 -0
- data/docs/GetTransacEmailsList.md +8 -0
- data/docs/GetTransacEmailsListTransactionalEmails.md +13 -0
- data/docs/SMTPApi.md +152 -25
- data/docs/UpdateChildAccountStatus.md +1 -1
- data/docs/UpdateContact.md +1 -1
- data/lib/sib-api-v3-sdk.rb +4 -0
- data/lib/sib-api-v3-sdk/api/smtp_api.rb +137 -18
- data/lib/sib-api-v3-sdk/models/create_contact.rb +1 -1
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +1 -1
- data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +1 -1
- data/lib/sib-api-v3-sdk/models/get_account_relay.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_account_relay_data.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_smtp_templates.rb +1 -1
- data/lib/sib-api-v3-sdk/models/get_transac_email_content.rb +281 -0
- data/lib/sib-api-v3-sdk/models/get_transac_email_content_events.rb +209 -0
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list.rb +190 -0
- data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +264 -0
- data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +1 -1
- data/lib/sib-api-v3-sdk/models/update_contact.rb +1 -1
- data/lib/sib-api-v3-sdk/version.rb +1 -1
- data/spec/api/smtp_api_spec.rb +37 -9
- data/spec/models/create_webhook_spec.rb +1 -1
- data/spec/models/get_transac_email_content_events_spec.rb +48 -0
- data/spec/models/get_transac_email_content_spec.rb +78 -0
- data/spec/models/get_transac_emails_list_spec.rb +42 -0
- data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +72 -0
- data/spec/models/update_webhook_spec.rb +1 -1
- metadata +18 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: dd0ab4fb75bc3eaaa37125c8c7a98d85439e201d3623bbf7ceb9827e4305c5c9
|
4
|
+
data.tar.gz: c698da50db4d1e33df123ff16e69afbf355f4d3272a575b9b48dcff37371f5d5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b6bdb70964c26ccc0d7176f50d06648326982b77b824b11c7145876ce7311765e877747e32fd85bc804451c4a9de4254a102a3dbeefa5e1fc8838039c770aa77
|
7
|
+
data.tar.gz: 24541bc8548a4a9e5b5b54c56831263d47061e80d8f2aa3e4d8669bd7825bb7fa0990270c9f2782dd334b97fc719981fb7e823d58efa23a4bb4533bc8c83a7ca
|
data/README.md
CHANGED
@@ -167,18 +167,20 @@ Class | Method | HTTP request | Description
|
|
167
167
|
*SibApiV3Sdk::SMSCampaignsApi* | [**send_test_sms**](docs/SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send an SMS
|
168
168
|
*SibApiV3Sdk::SMSCampaignsApi* | [**update_sms_campaign**](docs/SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Updates an SMS campaign
|
169
169
|
*SibApiV3Sdk::SMSCampaignsApi* | [**update_sms_campaign_status**](docs/SMSCampaignsApi.md#update_sms_campaign_status) | **PUT** /smsCampaigns/{campaignId}/status | Update the campaign status
|
170
|
-
*SibApiV3Sdk::SMTPApi* | [**create_smtp_template**](docs/SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create
|
170
|
+
*SibApiV3Sdk::SMTPApi* | [**create_smtp_template**](docs/SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create a transactional email template
|
171
171
|
*SibApiV3Sdk::SMTPApi* | [**delete_hardbounces**](docs/SMTPApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
|
172
|
-
*SibApiV3Sdk::SMTPApi* | [**delete_smtp_template**](docs/SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive
|
173
|
-
*SibApiV3Sdk::SMTPApi* | [**get_aggregated_smtp_report**](docs/SMTPApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your
|
174
|
-
*SibApiV3Sdk::SMTPApi* | [**get_email_event_report**](docs/SMTPApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your
|
175
|
-
*SibApiV3Sdk::SMTPApi* | [**get_smtp_report**](docs/SMTPApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your
|
172
|
+
*SibApiV3Sdk::SMTPApi* | [**delete_smtp_template**](docs/SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive transactional email template
|
173
|
+
*SibApiV3Sdk::SMTPApi* | [**get_aggregated_smtp_report**](docs/SMTPApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
|
174
|
+
*SibApiV3Sdk::SMTPApi* | [**get_email_event_report**](docs/SMTPApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
|
175
|
+
*SibApiV3Sdk::SMTPApi* | [**get_smtp_report**](docs/SMTPApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
|
176
176
|
*SibApiV3Sdk::SMTPApi* | [**get_smtp_template**](docs/SMTPApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template informations
|
177
|
-
*SibApiV3Sdk::SMTPApi* | [**get_smtp_templates**](docs/SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of
|
177
|
+
*SibApiV3Sdk::SMTPApi* | [**get_smtp_templates**](docs/SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of transactional email templates
|
178
|
+
*SibApiV3Sdk::SMTPApi* | [**get_transac_email_content**](docs/SMTPApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
|
179
|
+
*SibApiV3Sdk::SMTPApi* | [**get_transac_emails_list**](docs/SMTPApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
|
178
180
|
*SibApiV3Sdk::SMTPApi* | [**send_template**](docs/SMTPApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
|
179
181
|
*SibApiV3Sdk::SMTPApi* | [**send_test_template**](docs/SMTPApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
|
180
182
|
*SibApiV3Sdk::SMTPApi* | [**send_transac_email**](docs/SMTPApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
|
181
|
-
*SibApiV3Sdk::SMTPApi* | [**update_smtp_template**](docs/SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Updates
|
183
|
+
*SibApiV3Sdk::SMTPApi* | [**update_smtp_template**](docs/SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Updates a transactional email templates
|
182
184
|
*SibApiV3Sdk::SendersApi* | [**create_sender**](docs/SendersApi.md#create_sender) | **POST** /senders | Create a new sender
|
183
185
|
*SibApiV3Sdk::SendersApi* | [**delete_sender**](docs/SendersApi.md#delete_sender) | **DELETE** /senders/{senderId} | Delete a sender
|
184
186
|
*SibApiV3Sdk::SendersApi* | [**get_ips**](docs/SendersApi.md#get_ips) | **GET** /senders/ips | Return all the dedicated IPs for your account
|
@@ -295,6 +297,10 @@ Class | Method | HTTP request | Description
|
|
295
297
|
- [SibApiV3Sdk::GetSsoToken](docs/GetSsoToken.md)
|
296
298
|
- [SibApiV3Sdk::GetStatsByDomain](docs/GetStatsByDomain.md)
|
297
299
|
- [SibApiV3Sdk::GetTransacAggregatedSmsReport](docs/GetTransacAggregatedSmsReport.md)
|
300
|
+
- [SibApiV3Sdk::GetTransacEmailContent](docs/GetTransacEmailContent.md)
|
301
|
+
- [SibApiV3Sdk::GetTransacEmailContentEvents](docs/GetTransacEmailContentEvents.md)
|
302
|
+
- [SibApiV3Sdk::GetTransacEmailsList](docs/GetTransacEmailsList.md)
|
303
|
+
- [SibApiV3Sdk::GetTransacEmailsListTransactionalEmails](docs/GetTransacEmailsListTransactionalEmails.md)
|
298
304
|
- [SibApiV3Sdk::GetTransacSmsReport](docs/GetTransacSmsReport.md)
|
299
305
|
- [SibApiV3Sdk::GetTransacSmsReportReports](docs/GetTransacSmsReportReports.md)
|
300
306
|
- [SibApiV3Sdk::GetWebhook](docs/GetWebhook.md)
|
data/docs/CreateContact.md
CHANGED
@@ -9,6 +9,6 @@ Name | Type | Description | Notes
|
|
9
9
|
**sms_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional]
|
10
10
|
**list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional]
|
11
11
|
**update_enabled** | **BOOLEAN** | Facilitate to update the existing contact in the same request (updateEnabled = true) | [optional] [default to false]
|
12
|
-
**smtp_blacklist_sender** | **Array<String>** |
|
12
|
+
**smtp_blacklist_sender** | **Array<String>** | transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | [optional]
|
13
13
|
|
14
14
|
|
data/docs/CreateEmailCampaign.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**name** | **String** | Name of the campaign |
|
9
9
|
**html_content** | **String** | Mandatory if htmlUrl and templateId are empty. Body of the message (HTML) | [optional]
|
10
10
|
**html_url** | **String** | Mandatory if htmlContent and templateId are empty. Url to the message (HTML) | [optional]
|
11
|
-
**template_id** | **Integer** | Mandatory if htmlContent and htmlUrl are empty. Id of the
|
11
|
+
**template_id** | **Integer** | Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. | [optional]
|
12
12
|
**scheduled_at** | **DateTime** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional]
|
13
13
|
**subject** | **String** | Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. | [optional]
|
14
14
|
**reply_to** | **String** | Email on which the campaign recipients will be able to reply to | [optional]
|
data/docs/CreateSmtpEmail.md
CHANGED
data/docs/GetAccountRelay.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**enabled** | **BOOLEAN** | Status of your
|
6
|
+
**enabled** | **BOOLEAN** | Status of your transactional email Account (true=Enabled, false=Disabled) |
|
7
7
|
**data** | [**GetAccountRelayData**](GetAccountRelayData.md) | |
|
8
8
|
|
9
9
|
|
data/docs/GetAccountRelayData.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**user_name** | **String** | Email to use as login on
|
6
|
+
**user_name** | **String** | Email to use as login on transactional platform |
|
7
7
|
**relay** | **String** | URL of the SMTP Relay |
|
8
8
|
**port** | **Integer** | Port used for SMTP Relay |
|
9
9
|
|
data/docs/GetSmtpTemplates.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**count** | **Integer** | Count of
|
6
|
+
**count** | **Integer** | Count of transactional email templates | [optional]
|
7
7
|
**templates** | [**Array<GetSmtpTemplateOverview>**](GetSmtpTemplateOverview.md) | | [optional]
|
8
8
|
|
9
9
|
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# SibApiV3Sdk::GetTransacEmailContent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**email** | **String** | Email address to which transactional email has been sent |
|
7
|
+
**subject** | **String** | Subject of the sent email |
|
8
|
+
**template_id** | **Integer** | Id of the template | [optional]
|
9
|
+
**date** | **DateTime** | Date on which transactional email was sent |
|
10
|
+
**events** | [**Array<GetTransacEmailContentEvents>**](GetTransacEmailContentEvents.md) | Series of events which occurred on the transactional email |
|
11
|
+
**body** | **String** | Actual content of the transactional email that has been sent |
|
12
|
+
**attachment_count** | **Integer** | Count of the attachments that were sent in the email |
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SibApiV3Sdk::GetTransacEmailContentEvents
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | Name of the event that occurred on the sent email |
|
7
|
+
**time** | **DateTime** | Time at which the event occurred |
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# SibApiV3Sdk::GetTransacEmailsList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**transactional_emails** | [**Array<GetTransacEmailsListTransactionalEmails>**](GetTransacEmailsListTransactionalEmails.md) | | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# SibApiV3Sdk::GetTransacEmailsListTransactionalEmails
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**email** | **String** | Email address to which transactional email has been sent |
|
7
|
+
**subject** | **String** | Subject of the sent email |
|
8
|
+
**template_id** | **Integer** | Id of the template | [optional]
|
9
|
+
**message_id** | **String** | Message Id of the sent email |
|
10
|
+
**uuid** | **String** | Unique id of the email sent to a particular contact |
|
11
|
+
**date** | **DateTime** | Date on which transactional email was sent |
|
12
|
+
|
13
|
+
|
data/docs/SMTPApi.md
CHANGED
@@ -4,24 +4,26 @@ All URIs are relative to *https://api.sendinblue.com/v3*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**create_smtp_template**](SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create
|
7
|
+
[**create_smtp_template**](SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create a transactional email template
|
8
8
|
[**delete_hardbounces**](SMTPApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
|
9
|
-
[**delete_smtp_template**](SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive
|
10
|
-
[**get_aggregated_smtp_report**](SMTPApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your
|
11
|
-
[**get_email_event_report**](SMTPApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your
|
12
|
-
[**get_smtp_report**](SMTPApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your
|
9
|
+
[**delete_smtp_template**](SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive transactional email template
|
10
|
+
[**get_aggregated_smtp_report**](SMTPApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
|
11
|
+
[**get_email_event_report**](SMTPApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
|
12
|
+
[**get_smtp_report**](SMTPApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
|
13
13
|
[**get_smtp_template**](SMTPApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template informations
|
14
|
-
[**get_smtp_templates**](SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of
|
14
|
+
[**get_smtp_templates**](SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of transactional email templates
|
15
|
+
[**get_transac_email_content**](SMTPApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
|
16
|
+
[**get_transac_emails_list**](SMTPApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
|
15
17
|
[**send_template**](SMTPApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
|
16
18
|
[**send_test_template**](SMTPApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
|
17
19
|
[**send_transac_email**](SMTPApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
|
18
|
-
[**update_smtp_template**](SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Updates
|
20
|
+
[**update_smtp_template**](SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Updates a transactional email templates
|
19
21
|
|
20
22
|
|
21
23
|
# **create_smtp_template**
|
22
24
|
> CreateModel create_smtp_template(smtp_template)
|
23
25
|
|
24
|
-
Create
|
26
|
+
Create a transactional email template
|
25
27
|
|
26
28
|
### Example
|
27
29
|
```ruby
|
@@ -42,11 +44,11 @@ end
|
|
42
44
|
|
43
45
|
api_instance = SibApiV3Sdk::SMTPApi.new
|
44
46
|
|
45
|
-
smtp_template = SibApiV3Sdk::CreateSmtpTemplate.new # CreateSmtpTemplate | values to update in
|
47
|
+
smtp_template = SibApiV3Sdk::CreateSmtpTemplate.new # CreateSmtpTemplate | values to update in transactional email template
|
46
48
|
|
47
49
|
|
48
50
|
begin
|
49
|
-
#Create
|
51
|
+
#Create a transactional email template
|
50
52
|
result = api_instance.create_smtp_template(smtp_template)
|
51
53
|
p result
|
52
54
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -58,7 +60,7 @@ end
|
|
58
60
|
|
59
61
|
Name | Type | Description | Notes
|
60
62
|
------------- | ------------- | ------------- | -------------
|
61
|
-
**smtp_template** | [**CreateSmtpTemplate**](CreateSmtpTemplate.md)| values to update in
|
63
|
+
**smtp_template** | [**CreateSmtpTemplate**](CreateSmtpTemplate.md)| values to update in transactional email template |
|
62
64
|
|
63
65
|
### Return type
|
64
66
|
|
@@ -137,7 +139,7 @@ nil (empty response body)
|
|
137
139
|
# **delete_smtp_template**
|
138
140
|
> delete_smtp_template(template_id)
|
139
141
|
|
140
|
-
Delete an inactive
|
142
|
+
Delete an inactive transactional email template
|
141
143
|
|
142
144
|
### Example
|
143
145
|
```ruby
|
@@ -162,7 +164,7 @@ template_id = 789 # Integer | id of the template
|
|
162
164
|
|
163
165
|
|
164
166
|
begin
|
165
|
-
#Delete an inactive
|
167
|
+
#Delete an inactive transactional email template
|
166
168
|
api_instance.delete_smtp_template(template_id)
|
167
169
|
rescue SibApiV3Sdk::ApiError => e
|
168
170
|
puts "Exception when calling SMTPApi->delete_smtp_template: #{e}"
|
@@ -193,7 +195,7 @@ nil (empty response body)
|
|
193
195
|
# **get_aggregated_smtp_report**
|
194
196
|
> GetAggregatedReport get_aggregated_smtp_report(opts)
|
195
197
|
|
196
|
-
Get your
|
198
|
+
Get your transactional email activity aggregated over a period of time
|
197
199
|
|
198
200
|
### Example
|
199
201
|
```ruby
|
@@ -222,7 +224,7 @@ opts = {
|
|
222
224
|
}
|
223
225
|
|
224
226
|
begin
|
225
|
-
#Get your
|
227
|
+
#Get your transactional email activity aggregated over a period of time
|
226
228
|
result = api_instance.get_aggregated_smtp_report(opts)
|
227
229
|
p result
|
228
230
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -257,7 +259,7 @@ Name | Type | Description | Notes
|
|
257
259
|
# **get_email_event_report**
|
258
260
|
> GetEmailEventReport get_email_event_report(opts)
|
259
261
|
|
260
|
-
Get all your
|
262
|
+
Get all your transactional email activity (unaggregated events)
|
261
263
|
|
262
264
|
### Example
|
263
265
|
```ruby
|
@@ -292,7 +294,7 @@ opts = {
|
|
292
294
|
}
|
293
295
|
|
294
296
|
begin
|
295
|
-
#Get all your
|
297
|
+
#Get all your transactional email activity (unaggregated events)
|
296
298
|
result = api_instance.get_email_event_report(opts)
|
297
299
|
p result
|
298
300
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -333,7 +335,7 @@ Name | Type | Description | Notes
|
|
333
335
|
# **get_smtp_report**
|
334
336
|
> GetReports get_smtp_report(opts)
|
335
337
|
|
336
|
-
Get your
|
338
|
+
Get your transactional email activity aggregated per day
|
337
339
|
|
338
340
|
### Example
|
339
341
|
```ruby
|
@@ -364,7 +366,7 @@ opts = {
|
|
364
366
|
}
|
365
367
|
|
366
368
|
begin
|
367
|
-
#Get your
|
369
|
+
#Get your transactional email activity aggregated per day
|
368
370
|
result = api_instance.get_smtp_report(opts)
|
369
371
|
p result
|
370
372
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -458,7 +460,7 @@ Name | Type | Description | Notes
|
|
458
460
|
# **get_smtp_templates**
|
459
461
|
> GetSmtpTemplates get_smtp_templates(opts)
|
460
462
|
|
461
|
-
Get the list of
|
463
|
+
Get the list of transactional email templates
|
462
464
|
|
463
465
|
### Example
|
464
466
|
```ruby
|
@@ -486,7 +488,7 @@ opts = {
|
|
486
488
|
}
|
487
489
|
|
488
490
|
begin
|
489
|
-
#Get the list of
|
491
|
+
#Get the list of transactional email templates
|
490
492
|
result = api_instance.get_smtp_templates(opts)
|
491
493
|
p result
|
492
494
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -517,6 +519,131 @@ Name | Type | Description | Notes
|
|
517
519
|
|
518
520
|
|
519
521
|
|
522
|
+
# **get_transac_email_content**
|
523
|
+
> GetTransacEmailContent get_transac_email_content(uuid)
|
524
|
+
|
525
|
+
Get the personalized content of a sent transactional email
|
526
|
+
|
527
|
+
### Example
|
528
|
+
```ruby
|
529
|
+
# load the gem
|
530
|
+
require 'sib-api-v3-sdk'
|
531
|
+
# setup authorization
|
532
|
+
SibApiV3Sdk.configure do |config|
|
533
|
+
# Configure API key authorization: api-key
|
534
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
535
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
536
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
537
|
+
|
538
|
+
# Configure API key authorization: partner-key
|
539
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
540
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
541
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
542
|
+
end
|
543
|
+
|
544
|
+
api_instance = SibApiV3Sdk::SMTPApi.new
|
545
|
+
|
546
|
+
uuid = "uuid_example" # String | Unique id of the transactional email that has been sent to a particular contact
|
547
|
+
|
548
|
+
|
549
|
+
begin
|
550
|
+
#Get the personalized content of a sent transactional email
|
551
|
+
result = api_instance.get_transac_email_content(uuid)
|
552
|
+
p result
|
553
|
+
rescue SibApiV3Sdk::ApiError => e
|
554
|
+
puts "Exception when calling SMTPApi->get_transac_email_content: #{e}"
|
555
|
+
end
|
556
|
+
```
|
557
|
+
|
558
|
+
### Parameters
|
559
|
+
|
560
|
+
Name | Type | Description | Notes
|
561
|
+
------------- | ------------- | ------------- | -------------
|
562
|
+
**uuid** | **String**| Unique id of the transactional email that has been sent to a particular contact |
|
563
|
+
|
564
|
+
### Return type
|
565
|
+
|
566
|
+
[**GetTransacEmailContent**](GetTransacEmailContent.md)
|
567
|
+
|
568
|
+
### Authorization
|
569
|
+
|
570
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
571
|
+
|
572
|
+
### HTTP request headers
|
573
|
+
|
574
|
+
- **Content-Type**: application/json
|
575
|
+
- **Accept**: application/json
|
576
|
+
|
577
|
+
|
578
|
+
|
579
|
+
# **get_transac_emails_list**
|
580
|
+
> GetTransacEmailsList get_transac_emails_list(opts)
|
581
|
+
|
582
|
+
Get the list of transactional emails on the basis of allowed filters
|
583
|
+
|
584
|
+
This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.
|
585
|
+
|
586
|
+
### Example
|
587
|
+
```ruby
|
588
|
+
# load the gem
|
589
|
+
require 'sib-api-v3-sdk'
|
590
|
+
# setup authorization
|
591
|
+
SibApiV3Sdk.configure do |config|
|
592
|
+
# Configure API key authorization: api-key
|
593
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
594
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
595
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
596
|
+
|
597
|
+
# Configure API key authorization: partner-key
|
598
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
599
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
600
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
601
|
+
end
|
602
|
+
|
603
|
+
api_instance = SibApiV3Sdk::SMTPApi.new
|
604
|
+
|
605
|
+
opts = {
|
606
|
+
email: "email_example", # String | Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
|
607
|
+
template_id: 789, # Integer | Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
|
608
|
+
message_id: "message_id_example", # String | Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
|
609
|
+
start_date: "start_date_example", # String | 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.
|
610
|
+
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.
|
611
|
+
}
|
612
|
+
|
613
|
+
begin
|
614
|
+
#Get the list of transactional emails on the basis of allowed filters
|
615
|
+
result = api_instance.get_transac_emails_list(opts)
|
616
|
+
p result
|
617
|
+
rescue SibApiV3Sdk::ApiError => e
|
618
|
+
puts "Exception when calling SMTPApi->get_transac_emails_list: #{e}"
|
619
|
+
end
|
620
|
+
```
|
621
|
+
|
622
|
+
### Parameters
|
623
|
+
|
624
|
+
Name | Type | Description | Notes
|
625
|
+
------------- | ------------- | ------------- | -------------
|
626
|
+
**email** | **String**| Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. | [optional]
|
627
|
+
**template_id** | **Integer**| Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. | [optional]
|
628
|
+
**message_id** | **String**| Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. | [optional]
|
629
|
+
**start_date** | **String**| 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]
|
630
|
+
**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]
|
631
|
+
|
632
|
+
### Return type
|
633
|
+
|
634
|
+
[**GetTransacEmailsList**](GetTransacEmailsList.md)
|
635
|
+
|
636
|
+
### Authorization
|
637
|
+
|
638
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
639
|
+
|
640
|
+
### HTTP request headers
|
641
|
+
|
642
|
+
- **Content-Type**: application/json
|
643
|
+
- **Accept**: application/json
|
644
|
+
|
645
|
+
|
646
|
+
|
520
647
|
# **send_template**
|
521
648
|
> SendTemplateEmail send_template(template_id, send_email)
|
522
649
|
|
@@ -698,7 +825,7 @@ Name | Type | Description | Notes
|
|
698
825
|
# **update_smtp_template**
|
699
826
|
> update_smtp_template(template_id, smtp_template)
|
700
827
|
|
701
|
-
Updates
|
828
|
+
Updates a transactional email templates
|
702
829
|
|
703
830
|
### Example
|
704
831
|
```ruby
|
@@ -721,11 +848,11 @@ api_instance = SibApiV3Sdk::SMTPApi.new
|
|
721
848
|
|
722
849
|
template_id = 789 # Integer | id of the template
|
723
850
|
|
724
|
-
smtp_template = SibApiV3Sdk::UpdateSmtpTemplate.new # UpdateSmtpTemplate | values to update in
|
851
|
+
smtp_template = SibApiV3Sdk::UpdateSmtpTemplate.new # UpdateSmtpTemplate | values to update in transactional email template
|
725
852
|
|
726
853
|
|
727
854
|
begin
|
728
|
-
#Updates
|
855
|
+
#Updates a transactional email templates
|
729
856
|
api_instance.update_smtp_template(template_id, smtp_template)
|
730
857
|
rescue SibApiV3Sdk::ApiError => e
|
731
858
|
puts "Exception when calling SMTPApi->update_smtp_template: #{e}"
|
@@ -737,7 +864,7 @@ end
|
|
737
864
|
Name | Type | Description | Notes
|
738
865
|
------------- | ------------- | ------------- | -------------
|
739
866
|
**template_id** | **Integer**| id of the template |
|
740
|
-
**smtp_template** | [**UpdateSmtpTemplate**](UpdateSmtpTemplate.md)| values to update in
|
867
|
+
**smtp_template** | [**UpdateSmtpTemplate**](UpdateSmtpTemplate.md)| values to update in transactional email template |
|
741
868
|
|
742
869
|
### Return type
|
743
870
|
|