sib-api-v3-sdk 5.3.0 → 5.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (86) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +66 -62
  3. data/docs/AccountApi.md +3 -3
  4. data/docs/AddContactToList.md +1 -1
  5. data/docs/AttributesApi.md +12 -12
  6. data/docs/ContactsApi.md +110 -47
  7. data/docs/CreateAttribute.md +1 -1
  8. data/docs/CreateContact.md +2 -2
  9. data/docs/CreateDoiContact.md +13 -0
  10. data/docs/CreateEmailCampaign.md +1 -1
  11. data/docs/EmailCampaignsApi.md +78 -21
  12. data/docs/FoldersApi.md +12 -12
  13. data/docs/GetEmailCampaign.md +1 -0
  14. data/docs/GetExtendedCampaignOverview.md +1 -0
  15. data/docs/GetTransacBlockedContactsContacts.md +1 -1
  16. data/docs/GetTransacEmailsListTransactionalEmails.md +2 -0
  17. data/docs/ListsApi.md +12 -12
  18. data/docs/RemainingCreditModelChild.md +2 -2
  19. data/docs/RemainingCreditModelReseller.md +2 -2
  20. data/docs/RemoveContactFromList.md +1 -1
  21. data/docs/RequestContactExport.md +1 -1
  22. data/docs/RequestContactImport.md +1 -1
  23. data/docs/ResellerApi.md +30 -30
  24. data/docs/SMSCampaignsApi.md +21 -21
  25. data/docs/SMTPApi.md +17 -17
  26. data/docs/SendEmail.md +3 -3
  27. data/docs/SendSmtpEmail.md +3 -3
  28. data/docs/SendersApi.md +6 -6
  29. data/docs/TransactionalSMSApi.md +6 -6
  30. data/docs/UpdateAttribute.md +1 -1
  31. data/docs/UpdateContact.md +1 -1
  32. data/docs/UpdateEmailCampaign.md +1 -1
  33. data/docs/UploadImageToGallery.md +9 -0
  34. data/lib/sib-api-v3-sdk.rb +2 -0
  35. data/lib/sib-api-v3-sdk/api/account_api.rb +2 -2
  36. data/lib/sib-api-v3-sdk/api/attributes_api.rb +8 -8
  37. data/lib/sib-api-v3-sdk/api/contacts_api.rb +87 -30
  38. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +65 -14
  39. data/lib/sib-api-v3-sdk/api/folders_api.rb +8 -8
  40. data/lib/sib-api-v3-sdk/api/lists_api.rb +8 -8
  41. data/lib/sib-api-v3-sdk/api/reseller_api.rb +20 -20
  42. data/lib/sib-api-v3-sdk/api/senders_api.rb +4 -4
  43. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +14 -14
  44. data/lib/sib-api-v3-sdk/api/smtp_api.rb +12 -12
  45. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +4 -4
  46. data/lib/sib-api-v3-sdk/models/add_contact_to_list.rb +1 -1
  47. data/lib/sib-api-v3-sdk/models/create_attribute.rb +1 -1
  48. data/lib/sib-api-v3-sdk/models/create_contact.rb +2 -2
  49. data/lib/sib-api-v3-sdk/models/create_doi_contact.rb +253 -0
  50. data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +1 -1
  51. data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +11 -1
  52. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +14 -4
  53. data/lib/sib-api-v3-sdk/models/get_transac_blocked_contacts_contacts.rb +1 -1
  54. data/lib/sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails.rb +26 -4
  55. data/lib/sib-api-v3-sdk/models/remaining_credit_model_child.rb +2 -2
  56. data/lib/sib-api-v3-sdk/models/remaining_credit_model_reseller.rb +2 -2
  57. data/lib/sib-api-v3-sdk/models/remove_contact_from_list.rb +1 -1
  58. data/lib/sib-api-v3-sdk/models/request_contact_export.rb +1 -1
  59. data/lib/sib-api-v3-sdk/models/request_contact_import.rb +1 -1
  60. data/lib/sib-api-v3-sdk/models/send_email.rb +3 -3
  61. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +3 -3
  62. data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +1 -1
  63. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +1 -1
  64. data/lib/sib-api-v3-sdk/models/update_attribute.rb +1 -1
  65. data/lib/sib-api-v3-sdk/models/update_contact.rb +1 -1
  66. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +1 -1
  67. data/lib/sib-api-v3-sdk/models/upload_image_to_gallery.rb +199 -0
  68. data/lib/sib-api-v3-sdk/version.rb +1 -1
  69. data/sib-api-v3-sdk.gemspec +5 -5
  70. data/spec/api/account_api_spec.rb +1 -1
  71. data/spec/api/attributes_api_spec.rb +4 -4
  72. data/spec/api/contacts_api_spec.rb +28 -15
  73. data/spec/api/email_campaigns_api_spec.rb +18 -7
  74. data/spec/api/folders_api_spec.rb +4 -4
  75. data/spec/api/lists_api_spec.rb +4 -4
  76. data/spec/api/reseller_api_spec.rb +10 -10
  77. data/spec/api/senders_api_spec.rb +2 -2
  78. data/spec/api/sms_campaigns_api_spec.rb +7 -7
  79. data/spec/api/smtp_api_spec.rb +6 -6
  80. data/spec/api/transactional_sms_api_spec.rb +2 -2
  81. data/spec/models/create_doi_contact_spec.rb +71 -0
  82. data/spec/models/get_email_campaign_spec.rb +6 -0
  83. data/spec/models/get_extended_campaign_overview_spec.rb +6 -0
  84. data/spec/models/get_transac_emails_list_transactional_emails_spec.rb +12 -0
  85. data/spec/models/upload_image_to_gallery_spec.rb +47 -0
  86. metadata +10 -2
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **sms** | **Integer** | SMS Credits remaining for child account |
7
- **email** | **Integer** | Email Credits remaining for child account |
6
+ **sms** | **Float** | SMS Credits remaining for child account |
7
+ **email** | **Float** | Email Credits remaining for child account |
8
8
 
9
9
 
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **sms** | **Integer** | SMS Credits remaining for reseller account |
7
- **email** | **Integer** | Email Credits remaining for reseller account |
6
+ **sms** | **Float** | SMS Credits remaining for reseller account |
7
+ **email** | **Float** | Email Credits remaining for reseller account |
8
8
 
9
9
 
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **emails** | **Array<String>** | Required if 'all' is false. Emails to remove from a list | [optional]
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
7
  **all** | **BOOLEAN** | Required if 'emails' is empty. Remove all existing contacts from a list | [optional]
8
8
 
9
9
 
@@ -4,7 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **export_attributes** | **Array<String>** | List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email']. | [optional]
7
- **contact_filter** | **Object** | This attribute has been deprecated and will be removed by January 1st, 2021. Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported. For example, {'blacklisted':true} will export all the blacklisted contacts. | [optional]
7
+ **contact_filter** | **Object** | This attribute has been deprecated and will be removed by January 1st, 2021. Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported. For example, {\"blacklisted\":true} will export all the blacklisted contacts. | [optional]
8
8
  **custom_contact_filter** | [**RequestContactExportCustomContactFilter**](RequestContactExportCustomContactFilter.md) | | [optional]
9
9
  **notify_url** | **String** | Webhook that will be called once the export process is finished | [optional]
10
10
 
@@ -4,7 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **file_url** | **String** | Mandatory if fileBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv | [optional]
7
- **file_body** | **String** | Mandatory if fileUrl is not defined. CSV content to be imported. Use semicolon to separate multiple attributes | [optional]
7
+ **file_body** | **String** | Mandatory if fileUrl is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files. | [optional]
8
8
  **list_ids** | **Array<Integer>** | Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7]. | [optional]
9
9
  **notify_url** | **String** | URL that will be called once the export process is finished | [optional]
10
10
  **new_list** | [**RequestContactImportNewList**](RequestContactImportNewList.md) | | [optional]
@@ -6,20 +6,20 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**add_credits**](ResellerApi.md#add_credits) | **POST** /reseller/children/{childAuthKey}/credits/add | Add Email and/or SMS credits to a specific child account
8
8
  [**associate_ip_to_child**](ResellerApi.md#associate_ip_to_child) | **POST** /reseller/children/{childAuthKey}/ips/associate | Associate a dedicated IP to the child
9
- [**create_child_domain**](ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childAuthKey}/domains | Creates a domain for a child account
9
+ [**create_child_domain**](ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childAuthKey}/domains | Create a domain for a child account
10
10
  [**create_reseller_child**](ResellerApi.md#create_reseller_child) | **POST** /reseller/children | Creates a reseller child
11
- [**delete_child_domain**](ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{childAuthKey}/domains/{domainName} | Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed
12
- [**delete_reseller_child**](ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childAuthKey} | Deletes a single reseller child based on the childAuthKey supplied
11
+ [**delete_child_domain**](ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{childAuthKey}/domains/{domainName} | Delete the sender domain of the reseller child based on the childAuthKey and domainName passed
12
+ [**delete_reseller_child**](ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childAuthKey} | Delete a single reseller child based on the childAuthKey supplied
13
13
  [**dissociate_ip_from_child**](ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childAuthKey}/ips/dissociate | Dissociate a dedicated IP to the child
14
- [**get_child_account_creation_status**](ResellerApi.md#get_child_account_creation_status) | **GET** /reseller/children/{childAuthKey}/accountCreationStatus | Returns the status of reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
15
- [**get_child_domains**](ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childAuthKey}/domains | Gets all the sender domains of a specific child account
16
- [**get_child_info**](ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | Gets the info about a specific child account
17
- [**get_reseller_childs**](ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Gets the list of all reseller's children accounts
14
+ [**get_child_account_creation_status**](ResellerApi.md#get_child_account_creation_status) | **GET** /reseller/children/{childAuthKey}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
15
+ [**get_child_domains**](ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childAuthKey}/domains | Get all sender domains for a specific child account
16
+ [**get_child_info**](ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | Get a child account's details
17
+ [**get_reseller_childs**](ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Get the list of all children accounts
18
18
  [**get_sso_token**](ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childAuthKey}/auth | Get session token to access Sendinblue (SSO)
19
19
  [**remove_credits**](ResellerApi.md#remove_credits) | **POST** /reseller/children/{childAuthKey}/credits/remove | Remove Email and/or SMS credits from a specific child account
20
- [**update_child_account_status**](ResellerApi.md#update_child_account_status) | **PUT** /reseller/children/{childAuthKey}/accountStatus | Updates infos of reseller's child account status based on the childAuthKey supplied
21
- [**update_child_domain**](ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
22
- [**update_reseller_child**](ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childAuthKey} | Updates infos of reseller's child based on the childAuthKey supplied
20
+ [**update_child_account_status**](ResellerApi.md#update_child_account_status) | **PUT** /reseller/children/{childAuthKey}/accountStatus | Update info of reseller's child account status based on the childAuthKey supplied
21
+ [**update_child_domain**](ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Update the sender domain of reseller's child based on the childAuthKey and domainName passed
22
+ [**update_reseller_child**](ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childAuthKey} | Update info of reseller's child based on the childAuthKey supplied
23
23
 
24
24
 
25
25
  # **add_credits**
@@ -144,7 +144,7 @@ nil (empty response body)
144
144
  # **create_child_domain**
145
145
  > create_child_domain(child_auth_key, add_child_domain)
146
146
 
147
- Creates a domain for a child account
147
+ Create a domain for a child account
148
148
 
149
149
  ### Example
150
150
  ```ruby
@@ -171,7 +171,7 @@ add_child_domain = SibApiV3Sdk::AddChildDomain.new # AddChildDomain | Sender dom
171
171
 
172
172
 
173
173
  begin
174
- #Creates a domain for a child account
174
+ #Create a domain for a child account
175
175
  api_instance.create_child_domain(child_auth_key, add_child_domain)
176
176
  rescue SibApiV3Sdk::ApiError => e
177
177
  puts "Exception when calling ResellerApi->create_child_domain: #{e}"
@@ -261,7 +261,7 @@ Name | Type | Description | Notes
261
261
  # **delete_child_domain**
262
262
  > delete_child_domain(child_auth_key, domain_name)
263
263
 
264
- Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed
264
+ Delete the sender domain of the reseller child based on the childAuthKey and domainName passed
265
265
 
266
266
  ### Example
267
267
  ```ruby
@@ -288,7 +288,7 @@ domain_name = 'domain_name_example' # String | Pass the existing domain that nee
288
288
 
289
289
 
290
290
  begin
291
- #Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed
291
+ #Delete the sender domain of the reseller child based on the childAuthKey and domainName passed
292
292
  api_instance.delete_child_domain(child_auth_key, domain_name)
293
293
  rescue SibApiV3Sdk::ApiError => e
294
294
  puts "Exception when calling ResellerApi->delete_child_domain: #{e}"
@@ -320,7 +320,7 @@ nil (empty response body)
320
320
  # **delete_reseller_child**
321
321
  > delete_reseller_child(child_auth_key)
322
322
 
323
- Deletes a single reseller child based on the childAuthKey supplied
323
+ Delete a single reseller child based on the childAuthKey supplied
324
324
 
325
325
  ### Example
326
326
  ```ruby
@@ -345,7 +345,7 @@ child_auth_key = 'child_auth_key_example' # String | auth key of reseller's chil
345
345
 
346
346
 
347
347
  begin
348
- #Deletes a single reseller child based on the childAuthKey supplied
348
+ #Delete a single reseller child based on the childAuthKey supplied
349
349
  api_instance.delete_reseller_child(child_auth_key)
350
350
  rescue SibApiV3Sdk::ApiError => e
351
351
  puts "Exception when calling ResellerApi->delete_reseller_child: #{e}"
@@ -435,7 +435,7 @@ nil (empty response body)
435
435
  # **get_child_account_creation_status**
436
436
  > GetChildAccountCreationStatus get_child_account_creation_status(child_auth_key)
437
437
 
438
- Returns the status of reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
438
+ Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
439
439
 
440
440
  ### Example
441
441
  ```ruby
@@ -460,7 +460,7 @@ child_auth_key = 'child_auth_key_example' # String | auth key of reseller's chil
460
460
 
461
461
 
462
462
  begin
463
- #Returns the status of reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
463
+ #Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
464
464
  result = api_instance.get_child_account_creation_status(child_auth_key)
465
465
  p result
466
466
  rescue SibApiV3Sdk::ApiError => e
@@ -492,7 +492,7 @@ Name | Type | Description | Notes
492
492
  # **get_child_domains**
493
493
  > GetChildDomains get_child_domains(child_auth_key)
494
494
 
495
- Gets all the sender domains of a specific child account
495
+ Get all sender domains for a specific child account
496
496
 
497
497
  ### Example
498
498
  ```ruby
@@ -517,7 +517,7 @@ child_auth_key = 'child_auth_key_example' # String | auth key of reseller's chil
517
517
 
518
518
 
519
519
  begin
520
- #Gets all the sender domains of a specific child account
520
+ #Get all sender domains for a specific child account
521
521
  result = api_instance.get_child_domains(child_auth_key)
522
522
  p result
523
523
  rescue SibApiV3Sdk::ApiError => e
@@ -549,7 +549,7 @@ Name | Type | Description | Notes
549
549
  # **get_child_info**
550
550
  > GetChildInfo get_child_info(child_auth_key)
551
551
 
552
- Gets the info about a specific child account
552
+ Get a child account's details
553
553
 
554
554
  ### Example
555
555
  ```ruby
@@ -574,7 +574,7 @@ child_auth_key = 'child_auth_key_example' # String | auth key of reseller's chil
574
574
 
575
575
 
576
576
  begin
577
- #Gets the info about a specific child account
577
+ #Get a child account's details
578
578
  result = api_instance.get_child_info(child_auth_key)
579
579
  p result
580
580
  rescue SibApiV3Sdk::ApiError => e
@@ -606,7 +606,7 @@ Name | Type | Description | Notes
606
606
  # **get_reseller_childs**
607
607
  > GetChildrenList get_reseller_childs(opts)
608
608
 
609
- Gets the list of all reseller's children accounts
609
+ Get the list of all children accounts
610
610
 
611
611
  ### Example
612
612
  ```ruby
@@ -633,7 +633,7 @@ opts = {
633
633
  }
634
634
 
635
635
  begin
636
- #Gets the list of all reseller's children accounts
636
+ #Get the list of all children accounts
637
637
  result = api_instance.get_reseller_childs(opts)
638
638
  p result
639
639
  rescue SibApiV3Sdk::ApiError => e
@@ -785,7 +785,7 @@ Name | Type | Description | Notes
785
785
  # **update_child_account_status**
786
786
  > update_child_account_status(child_auth_key, update_child_account_status)
787
787
 
788
- Updates infos of reseller's child account status based on the childAuthKey supplied
788
+ Update info of reseller's child account status based on the childAuthKey supplied
789
789
 
790
790
  ### Example
791
791
  ```ruby
@@ -812,7 +812,7 @@ update_child_account_status = SibApiV3Sdk::UpdateChildAccountStatus.new # Update
812
812
 
813
813
 
814
814
  begin
815
- #Updates infos of reseller's child account status based on the childAuthKey supplied
815
+ #Update info of reseller's child account status based on the childAuthKey supplied
816
816
  api_instance.update_child_account_status(child_auth_key, update_child_account_status)
817
817
  rescue SibApiV3Sdk::ApiError => e
818
818
  puts "Exception when calling ResellerApi->update_child_account_status: #{e}"
@@ -844,7 +844,7 @@ nil (empty response body)
844
844
  # **update_child_domain**
845
845
  > update_child_domain(child_auth_key, domain_name, update_child_domain)
846
846
 
847
- Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
847
+ Update the sender domain of reseller's child based on the childAuthKey and domainName passed
848
848
 
849
849
  ### Example
850
850
  ```ruby
@@ -873,7 +873,7 @@ update_child_domain = SibApiV3Sdk::UpdateChildDomain.new # UpdateChildDomain | v
873
873
 
874
874
 
875
875
  begin
876
- #Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
876
+ #Update the sender domain of reseller's child based on the childAuthKey and domainName passed
877
877
  api_instance.update_child_domain(child_auth_key, domain_name, update_child_domain)
878
878
  rescue SibApiV3Sdk::ApiError => e
879
879
  puts "Exception when calling ResellerApi->update_child_domain: #{e}"
@@ -906,7 +906,7 @@ nil (empty response body)
906
906
  # **update_reseller_child**
907
907
  > update_reseller_child(child_auth_key, reseller_child)
908
908
 
909
- Updates infos of reseller's child based on the childAuthKey supplied
909
+ Update info of reseller's child based on the childAuthKey supplied
910
910
 
911
911
  ### Example
912
912
  ```ruby
@@ -933,7 +933,7 @@ reseller_child = SibApiV3Sdk::UpdateChild.new # UpdateChild | values to update i
933
933
 
934
934
 
935
935
  begin
936
- #Updates infos of reseller's child based on the childAuthKey supplied
936
+ #Update info of reseller's child based on the childAuthKey supplied
937
937
  api_instance.update_reseller_child(child_auth_key, reseller_child)
938
938
  rescue SibApiV3Sdk::ApiError => e
939
939
  puts "Exception when calling ResellerApi->update_reseller_child: #{e}"
@@ -5,15 +5,15 @@ All URIs are relative to *https://api.sendinblue.com/v3*
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**create_sms_campaign**](SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign
8
- [**delete_sms_campaign**](SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign
8
+ [**delete_sms_campaign**](SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete an SMS campaign
9
9
  [**get_sms_campaign**](SMSCampaignsApi.md#get_sms_campaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
10
- [**get_sms_campaigns**](SMSCampaignsApi.md#get_sms_campaigns) | **GET** /smsCampaigns | Returns the informations for all your created SMS campaigns
11
- [**request_sms_recipient_export**](SMSCampaignsApi.md#request_sms_recipient_export) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Exports the recipients of the specified campaign.
10
+ [**get_sms_campaigns**](SMSCampaignsApi.md#get_sms_campaigns) | **GET** /smsCampaigns | Returns the information for all your created SMS campaigns
11
+ [**request_sms_recipient_export**](SMSCampaignsApi.md#request_sms_recipient_export) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Export an SMS campaign's recipients
12
12
  [**send_sms_campaign_now**](SMSCampaignsApi.md#send_sms_campaign_now) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately
13
- [**send_sms_report**](SMSCampaignsApi.md#send_sms_report) | **POST** /smsCampaigns/{campaignId}/sendReport | Send report of SMS campaigns
14
- [**send_test_sms**](SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send an SMS
15
- [**update_sms_campaign**](SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Updates an SMS campaign
16
- [**update_sms_campaign_status**](SMSCampaignsApi.md#update_sms_campaign_status) | **PUT** /smsCampaigns/{campaignId}/status | Update the campaign status
13
+ [**send_sms_report**](SMSCampaignsApi.md#send_sms_report) | **POST** /smsCampaigns/{campaignId}/sendReport | Send an SMS campaign's report
14
+ [**send_test_sms**](SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign
15
+ [**update_sms_campaign**](SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Update an SMS campaign
16
+ [**update_sms_campaign_status**](SMSCampaignsApi.md#update_sms_campaign_status) | **PUT** /smsCampaigns/{campaignId}/status | Update a campaign's status
17
17
 
18
18
 
19
19
  # **create_sms_campaign**
@@ -76,7 +76,7 @@ Name | Type | Description | Notes
76
76
  # **delete_sms_campaign**
77
77
  > delete_sms_campaign(campaign_id)
78
78
 
79
- Delete the SMS campaign
79
+ Delete an SMS campaign
80
80
 
81
81
  ### Example
82
82
  ```ruby
@@ -101,7 +101,7 @@ campaign_id = 789 # Integer | id of the SMS campaign
101
101
 
102
102
 
103
103
  begin
104
- #Delete the SMS campaign
104
+ #Delete an SMS campaign
105
105
  api_instance.delete_sms_campaign(campaign_id)
106
106
  rescue SibApiV3Sdk::ApiError => e
107
107
  puts "Exception when calling SMSCampaignsApi->delete_sms_campaign: #{e}"
@@ -189,7 +189,7 @@ Name | Type | Description | Notes
189
189
  # **get_sms_campaigns**
190
190
  > GetSmsCampaigns get_sms_campaigns(opts)
191
191
 
192
- Returns the informations for all your created SMS campaigns
192
+ Returns the information for all your created SMS campaigns
193
193
 
194
194
  ### Example
195
195
  ```ruby
@@ -219,7 +219,7 @@ opts = {
219
219
  }
220
220
 
221
221
  begin
222
- #Returns the informations for all your created SMS campaigns
222
+ #Returns the information for all your created SMS campaigns
223
223
  result = api_instance.get_sms_campaigns(opts)
224
224
  p result
225
225
  rescue SibApiV3Sdk::ApiError => e
@@ -255,7 +255,7 @@ Name | Type | Description | Notes
255
255
  # **request_sms_recipient_export**
256
256
  > CreatedProcessId request_sms_recipient_export(campaign_id, opts)
257
257
 
258
- Exports the recipients of the specified campaign.
258
+ Export an SMS campaign's recipients
259
259
 
260
260
  It returns the background process ID which on completion calls the notify URL that you have set in the input.
261
261
 
@@ -285,7 +285,7 @@ opts = {
285
285
  }
286
286
 
287
287
  begin
288
- #Exports the recipients of the specified campaign.
288
+ #Export an SMS campaign's recipients
289
289
  result = api_instance.request_sms_recipient_export(campaign_id, opts)
290
290
  p result
291
291
  rescue SibApiV3Sdk::ApiError => e
@@ -374,7 +374,7 @@ nil (empty response body)
374
374
  # **send_sms_report**
375
375
  > send_sms_report(campaign_id, send_report)
376
376
 
377
- Send report of SMS campaigns
377
+ Send an SMS campaign's report
378
378
 
379
379
  Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.
380
380
 
@@ -403,7 +403,7 @@ send_report = SibApiV3Sdk::SendReport.new # SendReport | Values for send a repor
403
403
 
404
404
 
405
405
  begin
406
- #Send report of SMS campaigns
406
+ #Send an SMS campaign's report
407
407
  api_instance.send_sms_report(campaign_id, send_report)
408
408
  rescue SibApiV3Sdk::ApiError => e
409
409
  puts "Exception when calling SMSCampaignsApi->send_sms_report: #{e}"
@@ -435,7 +435,7 @@ nil (empty response body)
435
435
  # **send_test_sms**
436
436
  > send_test_sms(campaign_id, phone_number)
437
437
 
438
- Send an SMS
438
+ Send a test SMS campaign
439
439
 
440
440
  ### Example
441
441
  ```ruby
@@ -462,7 +462,7 @@ phone_number = SibApiV3Sdk::SendTestSms.new # SendTestSms | Mobile number of the
462
462
 
463
463
 
464
464
  begin
465
- #Send an SMS
465
+ #Send a test SMS campaign
466
466
  api_instance.send_test_sms(campaign_id, phone_number)
467
467
  rescue SibApiV3Sdk::ApiError => e
468
468
  puts "Exception when calling SMSCampaignsApi->send_test_sms: #{e}"
@@ -494,7 +494,7 @@ nil (empty response body)
494
494
  # **update_sms_campaign**
495
495
  > update_sms_campaign(campaign_id, update_sms_campaign)
496
496
 
497
- Updates an SMS campaign
497
+ Update an SMS campaign
498
498
 
499
499
  ### Example
500
500
  ```ruby
@@ -521,7 +521,7 @@ update_sms_campaign = SibApiV3Sdk::UpdateSmsCampaign.new # UpdateSmsCampaign | V
521
521
 
522
522
 
523
523
  begin
524
- #Updates an SMS campaign
524
+ #Update an SMS campaign
525
525
  api_instance.update_sms_campaign(campaign_id, update_sms_campaign)
526
526
  rescue SibApiV3Sdk::ApiError => e
527
527
  puts "Exception when calling SMSCampaignsApi->update_sms_campaign: #{e}"
@@ -553,7 +553,7 @@ nil (empty response body)
553
553
  # **update_sms_campaign_status**
554
554
  > update_sms_campaign_status(campaign_id, status)
555
555
 
556
- Update the campaign status
556
+ Update a campaign's status
557
557
 
558
558
  ### Example
559
559
  ```ruby
@@ -580,7 +580,7 @@ status = SibApiV3Sdk::UpdateCampaignStatus.new # UpdateCampaignStatus | Status o
580
580
 
581
581
 
582
582
  begin
583
- #Update the campaign status
583
+ #Update a campaign's status
584
584
  api_instance.update_sms_campaign_status(campaign_id, status)
585
585
  rescue SibApiV3Sdk::ApiError => e
586
586
  puts "Exception when calling SMSCampaignsApi->update_sms_campaign_status: #{e}"
@@ -4,14 +4,14 @@ 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 a transactional email template
7
+ [**create_smtp_template**](SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create an 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 transactional email template
9
+ [**delete_smtp_template**](SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
10
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
11
  [**get_email_event_report**](SMTPApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
12
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 informations
14
- [**get_smtp_templates**](SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of transactional email templates
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
15
  [**get_transac_blocked_contacts**](SMTPApi.md#get_transac_blocked_contacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
16
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
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
@@ -20,13 +20,13 @@ Method | HTTP request | Description
20
20
  [**send_transac_email**](SMTPApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
21
21
  [**smtp_blocked_contacts_email_delete**](SMTPApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
22
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} | Updates a transactional email templates
23
+ [**update_smtp_template**](SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template
24
24
 
25
25
 
26
26
  # **create_smtp_template**
27
27
  > CreateModel create_smtp_template(smtp_template)
28
28
 
29
- Create a transactional email template
29
+ Create an email template
30
30
 
31
31
  ### Example
32
32
  ```ruby
@@ -51,7 +51,7 @@ smtp_template = SibApiV3Sdk::CreateSmtpTemplate.new # CreateSmtpTemplate | value
51
51
 
52
52
 
53
53
  begin
54
- #Create a transactional email template
54
+ #Create an email template
55
55
  result = api_instance.create_smtp_template(smtp_template)
56
56
  p result
57
57
  rescue SibApiV3Sdk::ApiError => e
@@ -142,7 +142,7 @@ nil (empty response body)
142
142
  # **delete_smtp_template**
143
143
  > delete_smtp_template(template_id)
144
144
 
145
- Delete an inactive transactional email template
145
+ Delete an inactive email template
146
146
 
147
147
  ### Example
148
148
  ```ruby
@@ -167,7 +167,7 @@ template_id = 789 # Integer | id of the template
167
167
 
168
168
 
169
169
  begin
170
- #Delete an inactive transactional email template
170
+ #Delete an inactive email template
171
171
  api_instance.delete_smtp_template(template_id)
172
172
  rescue SibApiV3Sdk::ApiError => e
173
173
  puts "Exception when calling SMTPApi->delete_smtp_template: #{e}"
@@ -406,7 +406,7 @@ Name | Type | Description | Notes
406
406
  # **get_smtp_template**
407
407
  > GetSmtpTemplateOverview get_smtp_template(template_id)
408
408
 
409
- Returns the template informations
409
+ Returns the template information
410
410
 
411
411
  ### Example
412
412
  ```ruby
@@ -431,7 +431,7 @@ template_id = 789 # Integer | id of the template
431
431
 
432
432
 
433
433
  begin
434
- #Returns the template informations
434
+ #Returns the template information
435
435
  result = api_instance.get_smtp_template(template_id)
436
436
  p result
437
437
  rescue SibApiV3Sdk::ApiError => e
@@ -463,7 +463,7 @@ Name | Type | Description | Notes
463
463
  # **get_smtp_templates**
464
464
  > GetSmtpTemplates get_smtp_templates(opts)
465
465
 
466
- Get the list of transactional email templates
466
+ Get the list of email templates
467
467
 
468
468
  ### Example
469
469
  ```ruby
@@ -491,7 +491,7 @@ opts = {
491
491
  }
492
492
 
493
493
  begin
494
- #Get the list of transactional email templates
494
+ #Get the list of email templates
495
495
  result = api_instance.get_smtp_templates(opts)
496
496
  p result
497
497
  rescue SibApiV3Sdk::ApiError => e
@@ -675,7 +675,7 @@ 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.
676
676
  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.
677
677
  message_id: 'message_id_example', # String | Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
678
- 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.
678
+ start_date: Date.parse('2013-10-20'), # Date | 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.
679
679
  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.
680
680
  }
681
681
 
@@ -695,7 +695,7 @@ Name | Type | Description | Notes
695
695
  **email** | **String**| Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. | [optional]
696
696
  **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]
697
697
  **message_id** | **String**| Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. | [optional]
698
- **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]
698
+ **start_date** | **Date**| 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]
699
699
  **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]
700
700
 
701
701
  ### Return type
@@ -1006,7 +1006,7 @@ nil (empty response body)
1006
1006
  # **update_smtp_template**
1007
1007
  > update_smtp_template(template_id, smtp_template)
1008
1008
 
1009
- Updates a transactional email templates
1009
+ Update an email template
1010
1010
 
1011
1011
  ### Example
1012
1012
  ```ruby
@@ -1033,7 +1033,7 @@ smtp_template = SibApiV3Sdk::UpdateSmtpTemplate.new # UpdateSmtpTemplate | value
1033
1033
 
1034
1034
 
1035
1035
  begin
1036
- #Updates a transactional email templates
1036
+ #Update an email template
1037
1037
  api_instance.update_smtp_template(template_id, smtp_template)
1038
1038
  rescue SibApiV3Sdk::ApiError => e
1039
1039
  puts "Exception when calling SMTPApi->update_smtp_template: #{e}"