sib-api-v3-sdk 5.4.0 → 7.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +42 -37
- data/docs/AbTestCampaignResult.md +2 -0
- data/docs/AbTestCampaignResultClickedLinks.md +9 -0
- data/docs/AbTestCampaignResultStatistics.md +13 -0
- data/docs/AbTestVersionClicks.md +7 -0
- data/docs/AbTestVersionClicksInner.md +10 -0
- data/docs/AbTestVersionStats.md +9 -0
- data/docs/AddContactToList.md +2 -1
- data/docs/ContactsApi.md +29 -29
- data/docs/CreateChild.md +1 -0
- data/docs/CreateDoiContact.md +2 -2
- data/docs/CreateReseller.md +1 -0
- data/docs/CreateSender.md +1 -1
- data/docs/CreateSmsCampaign.md +1 -1
- data/docs/CreateWebhook.md +1 -1
- data/docs/EmailExportRecipients.md +1 -1
- data/docs/GetAggregatedReport.md +13 -13
- data/docs/GetCampaignStats.md +1 -0
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +1 -1
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +1 -1
- data/docs/GetSmtpTemplateOverview.md +1 -0
- data/docs/ListsApi.md +4 -4
- data/docs/PostContactInfoContacts.md +1 -0
- data/docs/RemoveContactFromList.md +2 -1
- data/docs/RequestContactExport.md +1 -1
- data/docs/RequestContactImport.md +1 -1
- data/docs/RequestSMSRecipientExport.md +1 -1
- data/docs/ResellerApi.md +82 -82
- data/docs/SendReportEmail.md +1 -5
- data/docs/SendSmtpEmail.md +1 -1
- data/docs/SendSmtpEmailSender.md +1 -0
- data/docs/SendTransacSms.md +1 -1
- data/docs/{SMTPApi.md → TransactionalEmailsApi.md} +52 -52
- data/docs/TransactionalSMSApi.md +3 -3
- data/docs/UpdateChildAccountStatus.md +1 -0
- data/docs/UpdateSmsCampaign.md +1 -1
- data/docs/UpdateWebhook.md +1 -1
- data/lib/sib-api-v3-sdk.rb +6 -1
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +44 -44
- data/lib/sib-api-v3-sdk/api/lists_api.rb +4 -4
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +138 -138
- data/lib/sib-api-v3-sdk/api/{smtp_api.rb → transactional_emails_api.rb} +52 -52
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +2 -2
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +22 -4
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links.rb +202 -0
- data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_statistics.rb +258 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_clicks.rb +175 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_clicks_inner.rb +219 -0
- data/lib/sib-api-v3-sdk/models/ab_test_version_stats.rb +205 -0
- data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +17 -5
- data/lib/sib-api-v3-sdk/models/create_child.rb +48 -4
- data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +7 -2
- data/lib/sib-api-v3-sdk/models/create_reseller.rb +14 -4
- data/lib/sib-api-v3-sdk/models/create_sender.rb +1 -1
- data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +6 -6
- data/lib/sib-api-v3-sdk/models/create_webhook.rb +1 -1
- data/lib/sib-api-v3-sdk/models/email_export_recipients.rb +1 -1
- data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +0 -65
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +14 -4
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +0 -5
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +0 -5
- data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +14 -4
- data/lib/sib-api-v3-sdk/models/post_contact_info_contacts.rb +14 -4
- data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +14 -2
- data/lib/sib-api-v3-sdk/models/request_contact_export.rb +1 -1
- data/lib/sib-api-v3-sdk/models/request_contact_import.rb +1 -1
- data/lib/sib-api-v3-sdk/models/request_sms_recipient_export.rb +1 -1
- data/lib/sib-api-v3-sdk/models/send_report_email.rb +3 -88
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +1 -1
- data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +15 -5
- data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +6 -6
- data/lib/sib-api-v3-sdk/models/update_child_account_status.rb +14 -4
- data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +6 -6
- data/lib/sib-api-v3-sdk/models/update_webhook.rb +1 -1
- data/lib/sib-api-v3-sdk/version.rb +1 -1
- data/spec/api/contacts_api_spec.rb +8 -8
- data/spec/api/lists_api_spec.rb +2 -2
- data/spec/api/reseller_api_spec.rb +20 -20
- data/spec/api/{smtp_api_spec.rb → transactional_emails_api_spec.rb} +6 -6
- data/spec/api/transactional_sms_api_spec.rb +1 -1
- data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +47 -0
- data/spec/models/ab_test_campaign_result_spec.rb +12 -0
- data/spec/models/ab_test_campaign_result_statistics_spec.rb +71 -0
- data/spec/models/ab_test_version_clicks_inner_spec.rb +53 -0
- data/spec/models/ab_test_version_clicks_spec.rb +35 -0
- data/spec/models/ab_test_version_stats_spec.rb +47 -0
- data/spec/models/add_contact_to_list_spec.rb +6 -0
- data/spec/models/create_child_spec.rb +10 -0
- data/spec/models/create_reseller_spec.rb +6 -0
- data/spec/models/create_webhook_spec.rb +1 -1
- data/spec/models/get_campaign_stats_spec.rb +6 -0
- data/spec/models/get_smtp_template_overview_spec.rb +6 -0
- data/spec/models/post_contact_info_contacts_spec.rb +6 -0
- data/spec/models/remove_contact_from_list_spec.rb +6 -0
- data/spec/models/send_report_email_spec.rb +0 -28
- data/spec/models/send_smtp_email_sender_spec.rb +6 -0
- data/spec/models/update_child_account_status_spec.rb +6 -0
- metadata +30 -10
data/docs/SendReportEmail.md
CHANGED
@@ -3,11 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**subject** | **String** | Subject of the email message |
|
7
6
|
**to** | **Array<String>** | Email addresses of the recipients |
|
8
|
-
**
|
9
|
-
**bcc** | **Array<String>** | Email addresses of the recipients in bcc | [optional]
|
10
|
-
**cc** | **Array<String>** | Email addresses of the recipients in cc | [optional]
|
11
|
-
**body** | **String** | Body of the email message |
|
7
|
+
**body** | **String** | Custom text message to be presented in the report email. |
|
12
8
|
|
13
9
|
|
data/docs/SendSmtpEmail.md
CHANGED
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
11
11
|
**text_content** | **String** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional]
|
12
12
|
**subject** | **String** | Subject of the message. Mandatory if 'templateId' is not passed | [optional]
|
13
13
|
**reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
|
14
|
-
**attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"
|
14
|
+
**attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional]
|
15
15
|
**headers** | **Object** | Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`. | [optional]
|
16
16
|
**template_id** | **Integer** | Id of the template | [optional]
|
17
17
|
**params** | **Object** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. | [optional]
|
data/docs/SendSmtpEmailSender.md
CHANGED
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**name** | **String** | Name of the sender from which the emails will be sent. Maximum allowed characters are 70. | [optional]
|
7
7
|
**email** | **String** | Email of the sender from which the emails will be sent |
|
8
|
+
**id** | **Integer** | Id of the sender from which the emails will be sent | [optional]
|
8
9
|
|
9
10
|
|
data/docs/SendTransacSms.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**sender** | **String** | Name of the sender.
|
6
|
+
**sender** | **String** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** |
|
7
7
|
**recipient** | **String** | Mobile number to send SMS with the country code |
|
8
8
|
**content** | **String** | Content of the message. If more than 160 characters long, will be sent as multiple text messages |
|
9
9
|
**type** | **String** | Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. | [optional] [default to 'transactional']
|
@@ -1,26 +1,26 @@
|
|
1
|
-
# SibApiV3Sdk::
|
1
|
+
# SibApiV3Sdk::TransactionalEmailsApi
|
2
2
|
|
3
3
|
All URIs are relative to *https://api.sendinblue.com/v3*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**create_smtp_template**](
|
8
|
-
[**delete_hardbounces**](
|
9
|
-
[**delete_smtp_template**](
|
10
|
-
[**get_aggregated_smtp_report**](
|
11
|
-
[**get_email_event_report**](
|
12
|
-
[**get_smtp_report**](
|
13
|
-
[**get_smtp_template**](
|
14
|
-
[**get_smtp_templates**](
|
15
|
-
[**get_transac_blocked_contacts**](
|
16
|
-
[**get_transac_email_content**](
|
17
|
-
[**get_transac_emails_list**](
|
18
|
-
[**send_template**](
|
19
|
-
[**send_test_template**](
|
20
|
-
[**send_transac_email**](
|
21
|
-
[**smtp_blocked_contacts_email_delete**](
|
22
|
-
[**smtp_log_message_id_delete**](
|
23
|
-
[**update_smtp_template**](
|
7
|
+
[**create_smtp_template**](TransactionalEmailsApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
|
8
|
+
[**delete_hardbounces**](TransactionalEmailsApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
|
9
|
+
[**delete_smtp_template**](TransactionalEmailsApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
|
10
|
+
[**get_aggregated_smtp_report**](TransactionalEmailsApi.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**](TransactionalEmailsApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
|
12
|
+
[**get_smtp_report**](TransactionalEmailsApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
|
13
|
+
[**get_smtp_template**](TransactionalEmailsApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
|
14
|
+
[**get_smtp_templates**](TransactionalEmailsApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates
|
15
|
+
[**get_transac_blocked_contacts**](TransactionalEmailsApi.md#get_transac_blocked_contacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
|
16
|
+
[**get_transac_email_content**](TransactionalEmailsApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
|
17
|
+
[**get_transac_emails_list**](TransactionalEmailsApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
|
18
|
+
[**send_template**](TransactionalEmailsApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
|
19
|
+
[**send_test_template**](TransactionalEmailsApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
|
20
|
+
[**send_transac_email**](TransactionalEmailsApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
|
21
|
+
[**smtp_blocked_contacts_email_delete**](TransactionalEmailsApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
|
22
|
+
[**smtp_log_message_id_delete**](TransactionalEmailsApi.md#smtp_log_message_id_delete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
|
23
|
+
[**update_smtp_template**](TransactionalEmailsApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template
|
24
24
|
|
25
25
|
|
26
26
|
# **create_smtp_template**
|
@@ -45,7 +45,7 @@ SibApiV3Sdk.configure do |config|
|
|
45
45
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
46
46
|
end
|
47
47
|
|
48
|
-
api_instance = SibApiV3Sdk::
|
48
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
49
49
|
|
50
50
|
smtp_template = SibApiV3Sdk::CreateSmtpTemplate.new # CreateSmtpTemplate | values to update in transactional email template
|
51
51
|
|
@@ -55,7 +55,7 @@ begin
|
|
55
55
|
result = api_instance.create_smtp_template(smtp_template)
|
56
56
|
p result
|
57
57
|
rescue SibApiV3Sdk::ApiError => e
|
58
|
-
puts "Exception when calling
|
58
|
+
puts "Exception when calling TransactionalEmailsApi->create_smtp_template: #{e}"
|
59
59
|
end
|
60
60
|
```
|
61
61
|
|
@@ -104,7 +104,7 @@ SibApiV3Sdk.configure do |config|
|
|
104
104
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
105
105
|
end
|
106
106
|
|
107
|
-
api_instance = SibApiV3Sdk::
|
107
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
108
108
|
|
109
109
|
opts = {
|
110
110
|
delete_hardbounces: SibApiV3Sdk::DeleteHardbounces.new # DeleteHardbounces | values to delete hardbounces
|
@@ -114,7 +114,7 @@ begin
|
|
114
114
|
#Delete hardbounces
|
115
115
|
api_instance.delete_hardbounces(opts)
|
116
116
|
rescue SibApiV3Sdk::ApiError => e
|
117
|
-
puts "Exception when calling
|
117
|
+
puts "Exception when calling TransactionalEmailsApi->delete_hardbounces: #{e}"
|
118
118
|
end
|
119
119
|
```
|
120
120
|
|
@@ -161,7 +161,7 @@ SibApiV3Sdk.configure do |config|
|
|
161
161
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
162
162
|
end
|
163
163
|
|
164
|
-
api_instance = SibApiV3Sdk::
|
164
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
165
165
|
|
166
166
|
template_id = 789 # Integer | id of the template
|
167
167
|
|
@@ -170,7 +170,7 @@ begin
|
|
170
170
|
#Delete an inactive email template
|
171
171
|
api_instance.delete_smtp_template(template_id)
|
172
172
|
rescue SibApiV3Sdk::ApiError => e
|
173
|
-
puts "Exception when calling
|
173
|
+
puts "Exception when calling TransactionalEmailsApi->delete_smtp_template: #{e}"
|
174
174
|
end
|
175
175
|
```
|
176
176
|
|
@@ -217,7 +217,7 @@ SibApiV3Sdk.configure do |config|
|
|
217
217
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
218
218
|
end
|
219
219
|
|
220
|
-
api_instance = SibApiV3Sdk::
|
220
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
221
221
|
|
222
222
|
opts = {
|
223
223
|
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
@@ -231,7 +231,7 @@ begin
|
|
231
231
|
result = api_instance.get_aggregated_smtp_report(opts)
|
232
232
|
p result
|
233
233
|
rescue SibApiV3Sdk::ApiError => e
|
234
|
-
puts "Exception when calling
|
234
|
+
puts "Exception when calling TransactionalEmailsApi->get_aggregated_smtp_report: #{e}"
|
235
235
|
end
|
236
236
|
```
|
237
237
|
|
@@ -281,7 +281,7 @@ SibApiV3Sdk.configure do |config|
|
|
281
281
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
282
282
|
end
|
283
283
|
|
284
|
-
api_instance = SibApiV3Sdk::
|
284
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
285
285
|
|
286
286
|
opts = {
|
287
287
|
limit: 50, # Integer | Number limitation for the result returned
|
@@ -301,7 +301,7 @@ begin
|
|
301
301
|
result = api_instance.get_email_event_report(opts)
|
302
302
|
p result
|
303
303
|
rescue SibApiV3Sdk::ApiError => e
|
304
|
-
puts "Exception when calling
|
304
|
+
puts "Exception when calling TransactionalEmailsApi->get_email_event_report: #{e}"
|
305
305
|
end
|
306
306
|
```
|
307
307
|
|
@@ -357,7 +357,7 @@ SibApiV3Sdk.configure do |config|
|
|
357
357
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
358
358
|
end
|
359
359
|
|
360
|
-
api_instance = SibApiV3Sdk::
|
360
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
361
361
|
|
362
362
|
opts = {
|
363
363
|
limit: 10, # Integer | Number of documents returned per page
|
@@ -373,7 +373,7 @@ begin
|
|
373
373
|
result = api_instance.get_smtp_report(opts)
|
374
374
|
p result
|
375
375
|
rescue SibApiV3Sdk::ApiError => e
|
376
|
-
puts "Exception when calling
|
376
|
+
puts "Exception when calling TransactionalEmailsApi->get_smtp_report: #{e}"
|
377
377
|
end
|
378
378
|
```
|
379
379
|
|
@@ -425,7 +425,7 @@ SibApiV3Sdk.configure do |config|
|
|
425
425
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
426
426
|
end
|
427
427
|
|
428
|
-
api_instance = SibApiV3Sdk::
|
428
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
429
429
|
|
430
430
|
template_id = 789 # Integer | id of the template
|
431
431
|
|
@@ -435,7 +435,7 @@ begin
|
|
435
435
|
result = api_instance.get_smtp_template(template_id)
|
436
436
|
p result
|
437
437
|
rescue SibApiV3Sdk::ApiError => e
|
438
|
-
puts "Exception when calling
|
438
|
+
puts "Exception when calling TransactionalEmailsApi->get_smtp_template: #{e}"
|
439
439
|
end
|
440
440
|
```
|
441
441
|
|
@@ -482,7 +482,7 @@ SibApiV3Sdk.configure do |config|
|
|
482
482
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
483
483
|
end
|
484
484
|
|
485
|
-
api_instance = SibApiV3Sdk::
|
485
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
486
486
|
|
487
487
|
opts = {
|
488
488
|
template_status: true, # BOOLEAN | Filter on the status of the template. Active = true, inactive = false
|
@@ -495,7 +495,7 @@ begin
|
|
495
495
|
result = api_instance.get_smtp_templates(opts)
|
496
496
|
p result
|
497
497
|
rescue SibApiV3Sdk::ApiError => e
|
498
|
-
puts "Exception when calling
|
498
|
+
puts "Exception when calling TransactionalEmailsApi->get_smtp_templates: #{e}"
|
499
499
|
end
|
500
500
|
```
|
501
501
|
|
@@ -544,7 +544,7 @@ SibApiV3Sdk.configure do |config|
|
|
544
544
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
545
545
|
end
|
546
546
|
|
547
|
-
api_instance = SibApiV3Sdk::
|
547
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
548
548
|
|
549
549
|
opts = {
|
550
550
|
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts
|
@@ -559,7 +559,7 @@ begin
|
|
559
559
|
result = api_instance.get_transac_blocked_contacts(opts)
|
560
560
|
p result
|
561
561
|
rescue SibApiV3Sdk::ApiError => e
|
562
|
-
puts "Exception when calling
|
562
|
+
puts "Exception when calling TransactionalEmailsApi->get_transac_blocked_contacts: #{e}"
|
563
563
|
end
|
564
564
|
```
|
565
565
|
|
@@ -610,7 +610,7 @@ SibApiV3Sdk.configure do |config|
|
|
610
610
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
611
611
|
end
|
612
612
|
|
613
|
-
api_instance = SibApiV3Sdk::
|
613
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
614
614
|
|
615
615
|
uuid = 'uuid_example' # String | Unique id of the transactional email that has been sent to a particular contact
|
616
616
|
|
@@ -620,7 +620,7 @@ begin
|
|
620
620
|
result = api_instance.get_transac_email_content(uuid)
|
621
621
|
p result
|
622
622
|
rescue SibApiV3Sdk::ApiError => e
|
623
|
-
puts "Exception when calling
|
623
|
+
puts "Exception when calling TransactionalEmailsApi->get_transac_email_content: #{e}"
|
624
624
|
end
|
625
625
|
```
|
626
626
|
|
@@ -669,7 +669,7 @@ SibApiV3Sdk.configure do |config|
|
|
669
669
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
670
670
|
end
|
671
671
|
|
672
|
-
api_instance = SibApiV3Sdk::
|
672
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
673
673
|
|
674
674
|
opts = {
|
675
675
|
email: 'email_example', # String | Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
|
@@ -684,7 +684,7 @@ begin
|
|
684
684
|
result = api_instance.get_transac_emails_list(opts)
|
685
685
|
p result
|
686
686
|
rescue SibApiV3Sdk::ApiError => e
|
687
|
-
puts "Exception when calling
|
687
|
+
puts "Exception when calling TransactionalEmailsApi->get_transac_emails_list: #{e}"
|
688
688
|
end
|
689
689
|
```
|
690
690
|
|
@@ -737,7 +737,7 @@ SibApiV3Sdk.configure do |config|
|
|
737
737
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
738
738
|
end
|
739
739
|
|
740
|
-
api_instance = SibApiV3Sdk::
|
740
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
741
741
|
|
742
742
|
template_id = 789 # Integer | Id of the template
|
743
743
|
|
@@ -749,7 +749,7 @@ begin
|
|
749
749
|
result = api_instance.send_template(template_id, send_email)
|
750
750
|
p result
|
751
751
|
rescue SibApiV3Sdk::ApiError => e
|
752
|
-
puts "Exception when calling
|
752
|
+
puts "Exception when calling TransactionalEmailsApi->send_template: #{e}"
|
753
753
|
end
|
754
754
|
```
|
755
755
|
|
@@ -797,7 +797,7 @@ SibApiV3Sdk.configure do |config|
|
|
797
797
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
798
798
|
end
|
799
799
|
|
800
|
-
api_instance = SibApiV3Sdk::
|
800
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
801
801
|
|
802
802
|
template_id = 789 # Integer | Id of the template
|
803
803
|
|
@@ -808,7 +808,7 @@ begin
|
|
808
808
|
#Send a template to your test list
|
809
809
|
api_instance.send_test_template(template_id, send_test_email)
|
810
810
|
rescue SibApiV3Sdk::ApiError => e
|
811
|
-
puts "Exception when calling
|
811
|
+
puts "Exception when calling TransactionalEmailsApi->send_test_template: #{e}"
|
812
812
|
end
|
813
813
|
```
|
814
814
|
|
@@ -856,7 +856,7 @@ SibApiV3Sdk.configure do |config|
|
|
856
856
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
857
857
|
end
|
858
858
|
|
859
|
-
api_instance = SibApiV3Sdk::
|
859
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
860
860
|
|
861
861
|
send_smtp_email = SibApiV3Sdk::SendSmtpEmail.new # SendSmtpEmail | Values to send a transactional email
|
862
862
|
|
@@ -866,7 +866,7 @@ begin
|
|
866
866
|
result = api_instance.send_transac_email(send_smtp_email)
|
867
867
|
p result
|
868
868
|
rescue SibApiV3Sdk::ApiError => e
|
869
|
-
puts "Exception when calling
|
869
|
+
puts "Exception when calling TransactionalEmailsApi->send_transac_email: #{e}"
|
870
870
|
end
|
871
871
|
```
|
872
872
|
|
@@ -913,7 +913,7 @@ SibApiV3Sdk.configure do |config|
|
|
913
913
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
914
914
|
end
|
915
915
|
|
916
|
-
api_instance = SibApiV3Sdk::
|
916
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
917
917
|
|
918
918
|
email = 'email_example' # String | contact email (urlencoded) to unblock.
|
919
919
|
|
@@ -922,7 +922,7 @@ begin
|
|
922
922
|
#Unblock or resubscribe a transactional contact
|
923
923
|
api_instance.smtp_blocked_contacts_email_delete(email)
|
924
924
|
rescue SibApiV3Sdk::ApiError => e
|
925
|
-
puts "Exception when calling
|
925
|
+
puts "Exception when calling TransactionalEmailsApi->smtp_blocked_contacts_email_delete: #{e}"
|
926
926
|
end
|
927
927
|
```
|
928
928
|
|
@@ -969,7 +969,7 @@ SibApiV3Sdk.configure do |config|
|
|
969
969
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
970
970
|
end
|
971
971
|
|
972
|
-
api_instance = SibApiV3Sdk::
|
972
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
973
973
|
|
974
974
|
message_id = 'message_id_example' # String | MessageId of the transactional log to delete
|
975
975
|
|
@@ -978,7 +978,7 @@ begin
|
|
978
978
|
#Delete an SMTP transactional log
|
979
979
|
api_instance.smtp_log_message_id_delete(message_id)
|
980
980
|
rescue SibApiV3Sdk::ApiError => e
|
981
|
-
puts "Exception when calling
|
981
|
+
puts "Exception when calling TransactionalEmailsApi->smtp_log_message_id_delete: #{e}"
|
982
982
|
end
|
983
983
|
```
|
984
984
|
|
@@ -1025,7 +1025,7 @@ SibApiV3Sdk.configure do |config|
|
|
1025
1025
|
#config.api_key_prefix['partner-key'] = 'Bearer'
|
1026
1026
|
end
|
1027
1027
|
|
1028
|
-
api_instance = SibApiV3Sdk::
|
1028
|
+
api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
|
1029
1029
|
|
1030
1030
|
template_id = 789 # Integer | id of the template
|
1031
1031
|
|
@@ -1036,7 +1036,7 @@ begin
|
|
1036
1036
|
#Update an email template
|
1037
1037
|
api_instance.update_smtp_template(template_id, smtp_template)
|
1038
1038
|
rescue SibApiV3Sdk::ApiError => e
|
1039
|
-
puts "Exception when calling
|
1039
|
+
puts "Exception when calling TransactionalEmailsApi->update_smtp_template: #{e}"
|
1040
1040
|
end
|
1041
1041
|
```
|
1042
1042
|
|
data/docs/TransactionalSMSApi.md
CHANGED
@@ -7,7 +7,7 @@ Method | HTTP request | Description
|
|
7
7
|
[**get_sms_events**](TransactionalSMSApi.md#get_sms_events) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events)
|
8
8
|
[**get_transac_aggregated_sms_report**](TransactionalSMSApi.md#get_transac_aggregated_sms_report) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time
|
9
9
|
[**get_transac_sms_report**](TransactionalSMSApi.md#get_transac_sms_report) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day
|
10
|
-
[**send_transac_sms**](TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send
|
10
|
+
[**send_transac_sms**](TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send SMS message to a mobile number
|
11
11
|
|
12
12
|
|
13
13
|
# **get_sms_events**
|
@@ -213,7 +213,7 @@ Name | Type | Description | Notes
|
|
213
213
|
# **send_transac_sms**
|
214
214
|
> SendSms send_transac_sms(send_transac_sms)
|
215
215
|
|
216
|
-
Send
|
216
|
+
Send SMS message to a mobile number
|
217
217
|
|
218
218
|
### Example
|
219
219
|
```ruby
|
@@ -238,7 +238,7 @@ send_transac_sms = SibApiV3Sdk::SendTransacSms.new # SendTransacSms | Values to
|
|
238
238
|
|
239
239
|
|
240
240
|
begin
|
241
|
-
#Send
|
241
|
+
#Send SMS message to a mobile number
|
242
242
|
result = api_instance.send_transac_sms(send_transac_sms)
|
243
243
|
p result
|
244
244
|
rescue SibApiV3Sdk::ApiError => e
|
@@ -6,5 +6,6 @@ Name | Type | Description | Notes
|
|
6
6
|
**transactional_email** | **BOOLEAN** | Status of Transactional Email Platform activation for your account (true=enabled, false=disabled) | [optional]
|
7
7
|
**transactional_sms** | **BOOLEAN** | Status of Transactional SMS Platform activation for your account (true=enabled, false=disabled) | [optional]
|
8
8
|
**marketing_automation** | **BOOLEAN** | Status of Marketing Automation Platform activation for your account (true=enabled, false=disabled) | [optional]
|
9
|
+
**sms_campaign** | **BOOLEAN** | Status of SMS Campaign Platform activation for your account (true=enabled, false=disabled) | [optional]
|
9
10
|
|
10
11
|
|
data/docs/UpdateSmsCampaign.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**name** | **String** | Name of the campaign | [optional]
|
7
|
-
**sender** | **String** | Name of the sender. The number of characters is limited to 11 | [optional]
|
7
|
+
**sender** | **String** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** | [optional]
|
8
8
|
**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]
|
9
9
|
**recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional]
|
10
10
|
**scheduled_at** | **DateTime** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
data/docs/UpdateWebhook.md
CHANGED
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**url** | **String** | URL of the webhook | [optional]
|
7
7
|
**description** | **String** | Description of the webhook | [optional]
|
8
|
-
**events** | **Array<String>** | Events triggering the webhook. Possible values for Transactional type webhook – request
|
8
|
+
**events** | **Array<String>** | Events triggering the webhook. Possible values for Transactional type webhook – `sent` OR `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` and `delivered` | [optional]
|
9
9
|
|
10
10
|
|
data/lib/sib-api-v3-sdk.rb
CHANGED
@@ -18,6 +18,11 @@ require 'sib-api-v3-sdk/configuration'
|
|
18
18
|
|
19
19
|
# Models
|
20
20
|
require 'sib-api-v3-sdk/models/ab_test_campaign_result'
|
21
|
+
require 'sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links'
|
22
|
+
require 'sib-api-v3-sdk/models/ab_test_campaign_result_statistics'
|
23
|
+
require 'sib-api-v3-sdk/models/ab_test_version_clicks'
|
24
|
+
require 'sib-api-v3-sdk/models/ab_test_version_clicks_inner'
|
25
|
+
require 'sib-api-v3-sdk/models/ab_test_version_stats'
|
21
26
|
require 'sib-api-v3-sdk/models/add_child_domain'
|
22
27
|
require 'sib-api-v3-sdk/models/add_contact_to_list'
|
23
28
|
require 'sib-api-v3-sdk/models/add_credits'
|
@@ -199,8 +204,8 @@ require 'sib-api-v3-sdk/api/lists_api'
|
|
199
204
|
require 'sib-api-v3-sdk/api/process_api'
|
200
205
|
require 'sib-api-v3-sdk/api/reseller_api'
|
201
206
|
require 'sib-api-v3-sdk/api/sms_campaigns_api'
|
202
|
-
require 'sib-api-v3-sdk/api/smtp_api'
|
203
207
|
require 'sib-api-v3-sdk/api/senders_api'
|
208
|
+
require 'sib-api-v3-sdk/api/transactional_emails_api'
|
204
209
|
require 'sib-api-v3-sdk/api/transactional_sms_api'
|
205
210
|
require 'sib-api-v3-sdk/api/webhooks_api'
|
206
211
|
|