sib-api-v3-sdk 5.5.0 → 7.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (59) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +26 -21
  3. data/docs/AbTestCampaignResult.md +2 -0
  4. data/docs/AbTestCampaignResultClickedLinks.md +9 -0
  5. data/docs/AbTestCampaignResultStatistics.md +13 -0
  6. data/docs/AbTestVersionClicks.md +7 -0
  7. data/docs/AbTestVersionClicksInner.md +10 -0
  8. data/docs/AbTestVersionStats.md +9 -0
  9. data/docs/AddContactToList.md +2 -1
  10. data/docs/ContactsApi.md +24 -24
  11. data/docs/CreateDoiContact.md +1 -1
  12. data/docs/CreateSmsCampaign.md +1 -1
  13. data/docs/CreateWebhook.md +1 -1
  14. data/docs/GetAggregatedReport.md +13 -13
  15. data/docs/GetCampaignStats.md +1 -0
  16. data/docs/ListsApi.md +4 -4
  17. data/docs/RemoveContactFromList.md +2 -1
  18. data/docs/SendSmtpEmailSender.md +1 -0
  19. data/docs/SendTransacSms.md +1 -1
  20. data/docs/{SMTPApi.md → TransactionalEmailsApi.md} +52 -52
  21. data/docs/UpdateSmsCampaign.md +1 -1
  22. data/docs/UpdateWebhook.md +1 -1
  23. data/lib/sib-api-v3-sdk.rb +6 -1
  24. data/lib/sib-api-v3-sdk/api/contacts_api.rb +40 -40
  25. data/lib/sib-api-v3-sdk/api/lists_api.rb +4 -4
  26. data/lib/sib-api-v3-sdk/api/{smtp_api.rb → transactional_emails_api.rb} +52 -52
  27. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb +22 -4
  28. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_clicked_links.rb +202 -0
  29. data/lib/sib-api-v3-sdk/models/ab_test_campaign_result_statistics.rb +258 -0
  30. data/lib/sib-api-v3-sdk/models/ab_test_version_clicks.rb +175 -0
  31. data/lib/sib-api-v3-sdk/models/ab_test_version_clicks_inner.rb +219 -0
  32. data/lib/sib-api-v3-sdk/models/ab_test_version_stats.rb +205 -0
  33. data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +17 -5
  34. data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +5 -0
  35. data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +6 -6
  36. data/lib/sib-api-v3-sdk/models/create_webhook.rb +1 -1
  37. data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +0 -65
  38. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +14 -4
  39. data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +14 -2
  40. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +15 -5
  41. data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +6 -6
  42. data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +6 -6
  43. data/lib/sib-api-v3-sdk/models/update_webhook.rb +1 -1
  44. data/lib/sib-api-v3-sdk/version.rb +1 -1
  45. data/spec/api/contacts_api_spec.rb +6 -6
  46. data/spec/api/lists_api_spec.rb +2 -2
  47. data/spec/api/{smtp_api_spec.rb → transactional_emails_api_spec.rb} +6 -6
  48. data/spec/models/ab_test_campaign_result_clicked_links_spec.rb +47 -0
  49. data/spec/models/ab_test_campaign_result_spec.rb +12 -0
  50. data/spec/models/ab_test_campaign_result_statistics_spec.rb +71 -0
  51. data/spec/models/ab_test_version_clicks_inner_spec.rb +53 -0
  52. data/spec/models/ab_test_version_clicks_spec.rb +35 -0
  53. data/spec/models/ab_test_version_stats_spec.rb +47 -0
  54. data/spec/models/add_contact_to_list_spec.rb +6 -0
  55. data/spec/models/get_campaign_stats_spec.rb +6 -0
  56. data/spec/models/remove_contact_from_list_spec.rb +6 -0
  57. data/spec/models/send_smtp_email_sender_spec.rb +6 -0
  58. data/testfile.rb +23 -0
  59. metadata +31 -10
@@ -4,6 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **emails** | **Array<String>** | Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request. | [optional]
7
- **all** | **BOOLEAN** | Required if 'emails' is empty. Remove all existing contacts from a list. A process will be created in this scenario. You can fetch the process details to know about the progress | [optional]
7
+ **ids** | **Array<Integer>** | Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional]
8
+ **all** | **BOOLEAN** | Required if none of 'emails' or 'ids' are passed. Remove all existing contacts from a list. A process will be created in this scenario. You can fetch the process details to know about the progress | [optional]
8
9
 
9
10
 
@@ -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
 
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **sender** | **String** | Name of the sender. Only alphanumeric characters. No more than 11 characters |
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::SMTPApi
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**](SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
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 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
- [**get_smtp_template**](SMTPApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
14
- [**get_smtp_templates**](SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of email templates
15
- [**get_transac_blocked_contacts**](SMTPApi.md#get_transac_blocked_contacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
16
- [**get_transac_email_content**](SMTPApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
17
- [**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
18
- [**send_template**](SMTPApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
19
- [**send_test_template**](SMTPApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
20
- [**send_transac_email**](SMTPApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
21
- [**smtp_blocked_contacts_email_delete**](SMTPApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
22
- [**smtp_log_message_id_delete**](SMTPApi.md#smtp_log_message_id_delete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
23
- [**update_smtp_template**](SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email 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::SMTPApi.new
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 SMTPApi->create_smtp_template: #{e}"
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::SMTPApi.new
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 SMTPApi->delete_hardbounces: #{e}"
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::SMTPApi.new
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 SMTPApi->delete_smtp_template: #{e}"
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::SMTPApi.new
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 SMTPApi->get_aggregated_smtp_report: #{e}"
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::SMTPApi.new
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 SMTPApi->get_email_event_report: #{e}"
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::SMTPApi.new
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 SMTPApi->get_smtp_report: #{e}"
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::SMTPApi.new
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 SMTPApi->get_smtp_template: #{e}"
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::SMTPApi.new
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 SMTPApi->get_smtp_templates: #{e}"
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::SMTPApi.new
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 SMTPApi->get_transac_blocked_contacts: #{e}"
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::SMTPApi.new
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 SMTPApi->get_transac_email_content: #{e}"
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::SMTPApi.new
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 SMTPApi->get_transac_emails_list: #{e}"
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::SMTPApi.new
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 SMTPApi->send_template: #{e}"
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::SMTPApi.new
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 SMTPApi->send_test_template: #{e}"
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::SMTPApi.new
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 SMTPApi->send_transac_email: #{e}"
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::SMTPApi.new
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 SMTPApi->smtp_blocked_contacts_email_delete: #{e}"
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::SMTPApi.new
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 SMTPApi->smtp_log_message_id_delete: #{e}"
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::SMTPApi.new
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 SMTPApi->update_smtp_template: #{e}"
1039
+ puts "Exception when calling TransactionalEmailsApi->update_smtp_template: #{e}"
1040
1040
  end
1041
1041
  ```
1042
1042
 
@@ -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]
@@ -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, 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]
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
 
@@ -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
 
@@ -21,7 +21,7 @@ module SibApiV3Sdk
21
21
  end
22
22
  # Add existing contacts to a list
23
23
  # @param list_id Id of the list
24
- # @param contact_emails Emails addresses of the contacts
24
+ # @param contact_emails Emails addresses OR IDs of the contacts
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [PostContactInfo]
27
27
  def add_contact_to_list(list_id, contact_emails, opts = {})
@@ -31,7 +31,7 @@ module SibApiV3Sdk
31
31
 
32
32
  # Add existing contacts to a list
33
33
  # @param list_id Id of the list
34
- # @param contact_emails Emails addresses of the contacts
34
+ # @param contact_emails Emails addresses OR IDs of the contacts
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(PostContactInfo, Fixnum, Hash)>] PostContactInfo data, response status code and response headers
37
37
  def add_contact_to_list_with_http_info(list_id, contact_emails, opts = {})
@@ -413,28 +413,28 @@ module SibApiV3Sdk
413
413
  return data, status_code, headers
414
414
  end
415
415
  # Delete a contact
416
- # @param email Email (urlencoded) of the contact
416
+ # @param identifier Email (urlencoded) OR ID of the contact
417
417
  # @param [Hash] opts the optional parameters
418
418
  # @return [nil]
419
- def delete_contact(email, opts = {})
420
- delete_contact_with_http_info(email, opts)
419
+ def delete_contact(identifier, opts = {})
420
+ delete_contact_with_http_info(identifier, opts)
421
421
  nil
422
422
  end
423
423
 
424
424
  # Delete a contact
425
- # @param email Email (urlencoded) of the contact
425
+ # @param identifier Email (urlencoded) OR ID of the contact
426
426
  # @param [Hash] opts the optional parameters
427
427
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
428
- def delete_contact_with_http_info(email, opts = {})
428
+ def delete_contact_with_http_info(identifier, opts = {})
429
429
  if @api_client.config.debugging
430
430
  @api_client.config.logger.debug 'Calling API: ContactsApi.delete_contact ...'
431
431
  end
432
- # verify the required parameter 'email' is set
433
- if @api_client.config.client_side_validation && email.nil?
434
- fail ArgumentError, "Missing the required parameter 'email' when calling ContactsApi.delete_contact"
432
+ # verify the required parameter 'identifier' is set
433
+ if @api_client.config.client_side_validation && identifier.nil?
434
+ fail ArgumentError, "Missing the required parameter 'identifier' when calling ContactsApi.delete_contact"
435
435
  end
436
436
  # resource path
437
- local_var_path = '/contacts/{email}'.sub('{' + 'email' + '}', email.to_s)
437
+ local_var_path = '/contacts/{identifier}'.sub('{' + 'identifier' + '}', identifier.to_s)
438
438
 
439
439
  # query parameters
440
440
  query_params = {}
@@ -612,28 +612,28 @@ module SibApiV3Sdk
612
612
  return data, status_code, headers
613
613
  end
614
614
  # Get a contact's details
615
- # @param email Email (urlencoded) of the contact OR its SMS attribute value
615
+ # @param identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value
616
616
  # @param [Hash] opts the optional parameters
617
617
  # @return [GetExtendedContactDetails]
618
- def get_contact_info(email, opts = {})
619
- data, _status_code, _headers = get_contact_info_with_http_info(email, opts)
618
+ def get_contact_info(identifier, opts = {})
619
+ data, _status_code, _headers = get_contact_info_with_http_info(identifier, opts)
620
620
  data
621
621
  end
622
622
 
623
623
  # Get a contact&#39;s details
624
- # @param email Email (urlencoded) of the contact OR its SMS attribute value
624
+ # @param identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value
625
625
  # @param [Hash] opts the optional parameters
626
626
  # @return [Array<(GetExtendedContactDetails, Fixnum, Hash)>] GetExtendedContactDetails data, response status code and response headers
627
- def get_contact_info_with_http_info(email, opts = {})
627
+ def get_contact_info_with_http_info(identifier, opts = {})
628
628
  if @api_client.config.debugging
629
629
  @api_client.config.logger.debug 'Calling API: ContactsApi.get_contact_info ...'
630
630
  end
631
- # verify the required parameter 'email' is set
632
- if @api_client.config.client_side_validation && email.nil?
633
- fail ArgumentError, "Missing the required parameter 'email' when calling ContactsApi.get_contact_info"
631
+ # verify the required parameter 'identifier' is set
632
+ if @api_client.config.client_side_validation && identifier.nil?
633
+ fail ArgumentError, "Missing the required parameter 'identifier' when calling ContactsApi.get_contact_info"
634
634
  end
635
635
  # resource path
636
- local_var_path = '/contacts/{email}'.sub('{' + 'email' + '}', email.to_s)
636
+ local_var_path = '/contacts/{identifier}'.sub('{' + 'identifier' + '}', identifier.to_s)
637
637
 
638
638
  # query parameters
639
639
  query_params = {}
@@ -664,32 +664,32 @@ module SibApiV3Sdk
664
664
  return data, status_code, headers
665
665
  end
666
666
  # Get email campaigns' statistics for a contact
667
- # @param email Email address (urlencoded) of the contact
667
+ # @param identifier Email (urlencoded) OR ID of the contact
668
668
  # @param [Hash] opts the optional parameters
669
669
  # @option opts [Date] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
670
670
  # @option opts [Date] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
671
671
  # @return [GetContactCampaignStats]
672
- def get_contact_stats(email, opts = {})
673
- data, _status_code, _headers = get_contact_stats_with_http_info(email, opts)
672
+ def get_contact_stats(identifier, opts = {})
673
+ data, _status_code, _headers = get_contact_stats_with_http_info(identifier, opts)
674
674
  data
675
675
  end
676
676
 
677
677
  # Get email campaigns&#39; statistics for a contact
678
- # @param email Email address (urlencoded) of the contact
678
+ # @param identifier Email (urlencoded) OR ID of the contact
679
679
  # @param [Hash] opts the optional parameters
680
680
  # @option opts [Date] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
681
681
  # @option opts [Date] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
682
682
  # @return [Array<(GetContactCampaignStats, Fixnum, Hash)>] GetContactCampaignStats data, response status code and response headers
683
- def get_contact_stats_with_http_info(email, opts = {})
683
+ def get_contact_stats_with_http_info(identifier, opts = {})
684
684
  if @api_client.config.debugging
685
685
  @api_client.config.logger.debug 'Calling API: ContactsApi.get_contact_stats ...'
686
686
  end
687
- # verify the required parameter 'email' is set
688
- if @api_client.config.client_side_validation && email.nil?
689
- fail ArgumentError, "Missing the required parameter 'email' when calling ContactsApi.get_contact_stats"
687
+ # verify the required parameter 'identifier' is set
688
+ if @api_client.config.client_side_validation && identifier.nil?
689
+ fail ArgumentError, "Missing the required parameter 'identifier' when calling ContactsApi.get_contact_stats"
690
690
  end
691
691
  # resource path
692
- local_var_path = '/contacts/{email}/campaignStats'.sub('{' + 'email' + '}', email.to_s)
692
+ local_var_path = '/contacts/{identifier}/campaignStats'.sub('{' + 'identifier' + '}', identifier.to_s)
693
693
 
694
694
  # query parameters
695
695
  query_params = {}
@@ -1187,7 +1187,7 @@ module SibApiV3Sdk
1187
1187
  end
1188
1188
  # Delete a contact from a list
1189
1189
  # @param list_id Id of the list
1190
- # @param contact_emails Emails adresses of the contact
1190
+ # @param contact_emails Emails addresses OR IDs of the contacts
1191
1191
  # @param [Hash] opts the optional parameters
1192
1192
  # @return [PostContactInfo]
1193
1193
  def remove_contact_from_list(list_id, contact_emails, opts = {})
@@ -1197,7 +1197,7 @@ module SibApiV3Sdk
1197
1197
 
1198
1198
  # Delete a contact from a list
1199
1199
  # @param list_id Id of the list
1200
- # @param contact_emails Emails adresses of the contact
1200
+ # @param contact_emails Emails addresses OR IDs of the contacts
1201
1201
  # @param [Hash] opts the optional parameters
1202
1202
  # @return [Array<(PostContactInfo, Fixnum, Hash)>] PostContactInfo data, response status code and response headers
1203
1203
  def remove_contact_from_list_with_http_info(list_id, contact_emails, opts = {})
@@ -1365,34 +1365,34 @@ module SibApiV3Sdk
1365
1365
  return data, status_code, headers
1366
1366
  end
1367
1367
  # Update a contact
1368
- # @param email Email (urlencoded) of the contact
1368
+ # @param identifier Email (urlencoded) OR ID of the contact
1369
1369
  # @param update_contact Values to update a contact
1370
1370
  # @param [Hash] opts the optional parameters
1371
1371
  # @return [nil]
1372
- def update_contact(email, update_contact, opts = {})
1373
- update_contact_with_http_info(email, update_contact, opts)
1372
+ def update_contact(identifier, update_contact, opts = {})
1373
+ update_contact_with_http_info(identifier, update_contact, opts)
1374
1374
  nil
1375
1375
  end
1376
1376
 
1377
1377
  # Update a contact
1378
- # @param email Email (urlencoded) of the contact
1378
+ # @param identifier Email (urlencoded) OR ID of the contact
1379
1379
  # @param update_contact Values to update a contact
1380
1380
  # @param [Hash] opts the optional parameters
1381
1381
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1382
- def update_contact_with_http_info(email, update_contact, opts = {})
1382
+ def update_contact_with_http_info(identifier, update_contact, opts = {})
1383
1383
  if @api_client.config.debugging
1384
1384
  @api_client.config.logger.debug 'Calling API: ContactsApi.update_contact ...'
1385
1385
  end
1386
- # verify the required parameter 'email' is set
1387
- if @api_client.config.client_side_validation && email.nil?
1388
- fail ArgumentError, "Missing the required parameter 'email' when calling ContactsApi.update_contact"
1386
+ # verify the required parameter 'identifier' is set
1387
+ if @api_client.config.client_side_validation && identifier.nil?
1388
+ fail ArgumentError, "Missing the required parameter 'identifier' when calling ContactsApi.update_contact"
1389
1389
  end
1390
1390
  # verify the required parameter 'update_contact' is set
1391
1391
  if @api_client.config.client_side_validation && update_contact.nil?
1392
1392
  fail ArgumentError, "Missing the required parameter 'update_contact' when calling ContactsApi.update_contact"
1393
1393
  end
1394
1394
  # resource path
1395
- local_var_path = '/contacts/{email}'.sub('{' + 'email' + '}', email.to_s)
1395
+ local_var_path = '/contacts/{identifier}'.sub('{' + 'identifier' + '}', identifier.to_s)
1396
1396
 
1397
1397
  # query parameters
1398
1398
  query_params = {}