sib-api-v3-sdk 4.0.1 → 5.0.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 +0 -1
- data/docs/CreateAttribute.md +3 -3
- data/docs/CreateContact.md +5 -5
- data/docs/CreateList.md +1 -1
- data/docs/DeleteHardbounces.md +2 -2
- data/docs/GetCampaignStats.md +3 -3
- data/docs/GetContactDetails.md +1 -1
- data/docs/GetExtendedCampaignStats.md +3 -2
- data/docs/GetExtendedContactDetails.md +1 -1
- data/docs/RequestContactExport.md +2 -2
- data/docs/RequestContactImport.md +5 -2
- data/docs/RequestContactImportNewList.md +1 -1
- data/docs/SMTPApi.md +2 -0
- data/docs/SendEmail.md +8 -7
- data/docs/SendEmailAttachment.md +2 -2
- data/docs/SendSmtpEmail.md +7 -6
- data/docs/SendSmtpEmailAttachment.md +1 -1
- data/docs/SendSmtpEmailSender.md +2 -2
- data/docs/SendTestEmail.md +1 -1
- data/docs/UpdateAttribute.md +2 -2
- data/docs/UpdateContact.md +3 -3
- data/docs/UpdateList.md +2 -2
- data/lib/sib-api-v3-sdk.rb +0 -1
- data/lib/sib-api-v3-sdk/api/smtp_api.rb +2 -2
- data/lib/sib-api-v3-sdk/models/create_attribute.rb +3 -3
- data/lib/sib-api-v3-sdk/models/create_contact.rb +5 -5
- data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +1 -1
- data/lib/sib-api-v3-sdk/models/create_email_campaign_sender.rb +1 -1
- data/lib/sib-api-v3-sdk/models/create_list.rb +1 -1
- data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +1 -1
- data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +2 -7
- data/lib/sib-api-v3-sdk/models/get_contact_details.rb +3 -4
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats.rb +20 -5
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +3 -4
- data/lib/sib-api-v3-sdk/models/request_contact_export.rb +2 -2
- data/lib/sib-api-v3-sdk/models/request_contact_import.rb +42 -6
- data/lib/sib-api-v3-sdk/models/request_contact_import_new_list.rb +2 -2
- data/lib/sib-api-v3-sdk/models/send_email.rb +25 -15
- data/lib/sib-api-v3-sdk/models/send_email_attachment.rb +16 -3
- data/lib/sib-api-v3-sdk/models/send_report_email.rb +1 -1
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +24 -14
- data/lib/sib-api-v3-sdk/models/send_smtp_email_attachment.rb +1 -1
- data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to.rb +1 -1
- data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +3 -3
- data/lib/sib-api-v3-sdk/models/send_test_email.rb +1 -1
- data/lib/sib-api-v3-sdk/models/update_attribute.rb +2 -2
- data/lib/sib-api-v3-sdk/models/update_contact.rb +5 -6
- data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +1 -1
- data/lib/sib-api-v3-sdk/models/update_email_campaign_sender.rb +1 -1
- data/lib/sib-api-v3-sdk/models/update_list.rb +2 -2
- data/lib/sib-api-v3-sdk/models/update_smtp_template_sender.rb +1 -1
- data/lib/sib-api-v3-sdk/version.rb +1 -1
- data/spec/api/smtp_api_spec.rb +1 -1
- data/spec/models/get_extended_campaign_stats_spec.rb +6 -0
- data/spec/models/request_contact_import_spec.rb +18 -0
- data/spec/models/send_email_spec.rb +6 -0
- data/spec/models/send_smtp_email_spec.rb +6 -0
- metadata +2 -6
- data/docs/GetExtendedCampaignStatsLinksStats.md +0 -8
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_stats_links_stats.rb +0 -194
- data/spec/models/get_extended_campaign_stats_links_stats_spec.rb +0 -42
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f37c5e31f9484352992cf53852c93f30651b77e8
|
4
|
+
data.tar.gz: 731e71d522e04ba7f1689773ed35047df678214b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6fe418830072aed1ba951e3e2bd87d0fb62eba03a05e81a0be44ca511fd1cfa5dda8acd2f1f67a592fd0155d0424cd3fc8f7677d3c7d6eb133bfd5c0ec0cdb38
|
7
|
+
data.tar.gz: 76688ffbf34debac50b8758651465d24a48ed0a3b4f84ab4cff79adc88188461e215c1ecbedc0a624696bfeda5a4f4c1619d994ed0bc55b8c05ace8dfc27c55f
|
data/README.md
CHANGED
@@ -243,7 +243,6 @@ Class | Method | HTTP request | Description
|
|
243
243
|
- [SibApiV3Sdk::GetEmailEventReportEvents](docs/GetEmailEventReportEvents.md)
|
244
244
|
- [SibApiV3Sdk::GetExtendedCampaignOverviewSender](docs/GetExtendedCampaignOverviewSender.md)
|
245
245
|
- [SibApiV3Sdk::GetExtendedCampaignStats](docs/GetExtendedCampaignStats.md)
|
246
|
-
- [SibApiV3Sdk::GetExtendedCampaignStatsLinksStats](docs/GetExtendedCampaignStatsLinksStats.md)
|
247
246
|
- [SibApiV3Sdk::GetExtendedClientAddress](docs/GetExtendedClientAddress.md)
|
248
247
|
- [SibApiV3Sdk::GetExtendedContactDetailsStatistics](docs/GetExtendedContactDetailsStatistics.md)
|
249
248
|
- [SibApiV3Sdk::GetExtendedContactDetailsStatisticsClicked](docs/GetExtendedContactDetailsStatisticsClicked.md)
|
data/docs/CreateAttribute.md
CHANGED
@@ -3,8 +3,8 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**value** | **String** | Value of the attribute. Use only if the attribute's category is calculated or global | [optional]
|
7
|
-
**enumeration** | [**Array<CreateAttributeEnumeration>**](CreateAttributeEnumeration.md) |
|
8
|
-
**type** | **String** | Type of the attribute. Use only if the attribute's category is normal
|
6
|
+
**value** | **String** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional]
|
7
|
+
**enumeration** | [**Array<CreateAttributeEnumeration>**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] | [optional]
|
8
|
+
**type** | **String** | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [optional]
|
9
9
|
|
10
10
|
|
data/docs/CreateContact.md
CHANGED
@@ -3,12 +3,12 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**email** | **String** | Email address of the user. Mandatory if
|
7
|
-
**attributes** | **Object** |
|
8
|
-
**email_blacklisted** | **BOOLEAN** |
|
9
|
-
**sms_blacklisted** | **BOOLEAN** |
|
6
|
+
**email** | **String** | Email address of the user. Mandatory if \"sms\" field is not passed in \"attributes\" parameter' | [optional]
|
7
|
+
**attributes** | **Object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} | [optional]
|
8
|
+
**email_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional]
|
9
|
+
**sms_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional]
|
10
10
|
**list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional]
|
11
|
-
**update_enabled** | **BOOLEAN** | Facilitate to update existing contact in same request (updateEnabled = true) | [optional] [default to false]
|
11
|
+
**update_enabled** | **BOOLEAN** | Facilitate to update the existing contact in the same request (updateEnabled = true) | [optional] [default to false]
|
12
12
|
**smtp_blacklist_sender** | **Array<String>** | SMTP forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | [optional]
|
13
13
|
|
14
14
|
|
data/docs/CreateList.md
CHANGED
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**name** | **String** | Name of the list |
|
7
|
-
**folder_id** | **Integer** | Id of the folder in which to
|
7
|
+
**folder_id** | **Integer** | Id of the parent folder in which this list is to be created |
|
8
8
|
|
9
9
|
|
data/docs/DeleteHardbounces.md
CHANGED
@@ -3,8 +3,8 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**start_date** | **Date** | Starting date (YYYY-MM-DD) of the period
|
7
|
-
**end_date** | **Date** | Ending date (YYYY-MM-DD) of the period
|
6
|
+
**start_date** | **Date** | Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate | [optional]
|
7
|
+
**end_date** | **Date** | Ending date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate | [optional]
|
8
8
|
**contact_email** | **String** | Target a specific email address | [optional]
|
9
9
|
|
10
10
|
|
data/docs/GetCampaignStats.md
CHANGED
@@ -3,9 +3,9 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**list_id** | **Integer** | List Id of email campaign (only in case of get email campaign(s)) | [optional]
|
6
|
+
**list_id** | **Integer** | List Id of email campaign (only in case of get email campaign(s)(not for global stats)) | [optional]
|
7
7
|
**unique_clicks** | **Integer** | Number of unique clicks for the campaign |
|
8
|
-
**clickers** | **Integer** | Number of clicks for the campaign |
|
8
|
+
**clickers** | **Integer** | Number of total clicks for the campaign |
|
9
9
|
**complaints** | **Integer** | Number of complaints (Spam reports) for the campaign |
|
10
10
|
**delivered** | **Integer** | Number of delivered emails for the campaign |
|
11
11
|
**sent** | **Integer** | Number of sent emails for the campaign |
|
@@ -14,6 +14,6 @@ Name | Type | Description | Notes
|
|
14
14
|
**unique_views** | **Integer** | Number of unique openings for the campaign |
|
15
15
|
**unsubscriptions** | **Integer** | Number of unsubscription for the campaign |
|
16
16
|
**viewed** | **Integer** | Number of openings for the campaign |
|
17
|
-
**deferred** | **Integer** | Number of deferred emails for the campaign |
|
17
|
+
**deferred** | **Integer** | Number of deferred emails for the campaign | [optional]
|
18
18
|
|
19
19
|
|
data/docs/GetContactDetails.md
CHANGED
@@ -10,6 +10,6 @@ Name | Type | Description | Notes
|
|
10
10
|
**modified_at** | **DateTime** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
11
11
|
**list_ids** | **Array<Integer>** | |
|
12
12
|
**list_unsubscribed** | **Array<Integer>** | | [optional]
|
13
|
-
**attributes** | **
|
13
|
+
**attributes** | **Object** | Set of attributes of the contact |
|
14
14
|
|
15
15
|
|
@@ -3,10 +3,11 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
6
|
+
**global_stats** | **Object** | Overall statistics of the campaign |
|
7
|
+
**campaign_stats** | **Array<Object>** | List-wise statistics of the campaign. |
|
7
8
|
**mirror_click** | **Integer** | Number of clicks on mirror link |
|
8
9
|
**remaining** | **Integer** | Number of remaning emails to send |
|
9
|
-
**links_stats** |
|
10
|
+
**links_stats** | **Object** | Statistics about the number of clicks for the links |
|
10
11
|
**stats_by_domain** | [**GetStatsByDomain**](GetStatsByDomain.md) | |
|
11
12
|
|
12
13
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
10
10
|
**modified_at** | **DateTime** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
11
11
|
**list_ids** | **Array<Integer>** | |
|
12
12
|
**list_unsubscribed** | **Array<Integer>** | | [optional]
|
13
|
-
**attributes** | **
|
13
|
+
**attributes** | **Object** | Set of attributes of the contact |
|
14
14
|
**statistics** | [**GetExtendedContactDetailsStatistics**](GetExtendedContactDetailsStatistics.md) | |
|
15
15
|
|
16
16
|
|
@@ -3,8 +3,8 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**export_attributes** | **Array<String>** |
|
7
|
-
**contact_filter** | **Object** |
|
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** | Set the filter for the contacts to be exported. For example, {'blacklisted':true} will export all the blacklisted contacts. |
|
8
8
|
**notify_url** | **String** | Webhook that will be called once the export process is finished | [optional]
|
9
9
|
|
10
10
|
|
@@ -3,10 +3,13 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**file_url** | **String** | Mandatory if fileBody not defined. URL of the file to be imported (no local file). Possible file
|
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
7
|
**file_body** | **String** | Mandatory if fileUrl is not defined. CSV content to be imported. Use semicolon to separate multiple attributes | [optional]
|
8
|
-
**list_ids** | **Array<Integer>** |
|
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]
|
11
|
+
**email_blacklist** | **BOOLEAN** | To blacklist all the contacts for email | [optional] [default to false]
|
12
|
+
**sms_blacklist** | **BOOLEAN** | To blacklist all the contacts for sms | [optional] [default to false]
|
13
|
+
**update_existing_contacts** | **BOOLEAN** | To facilitate the choice to update the existing contacts | [optional] [default to true]
|
11
14
|
|
12
15
|
|
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**list_name** | **String** | List with listName will be created first and users will be imported in it (Mandatory if listIds is empty). | [optional]
|
7
|
-
**folder_id** | **Integer** |
|
7
|
+
**folder_id** | **Integer** | Id of the folder where this new list shall be created (Mandatory if listName is not empty). | [optional]
|
8
8
|
|
9
9
|
|
data/docs/SMTPApi.md
CHANGED
data/docs/SendEmail.md
CHANGED
@@ -3,13 +3,14 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**email_to** | **Array<String>** |
|
7
|
-
**email_bcc** | **Array<String>** |
|
8
|
-
**email_cc** | **Array<String>** |
|
9
|
-
**reply_to** | **String** | Email
|
6
|
+
**email_to** | **Array<String>** | List of the email addresses of the recipients. For example, ['abc@example.com', 'asd@example.com']. |
|
7
|
+
**email_bcc** | **Array<String>** | List of the email addresses of the recipients in bcc | [optional]
|
8
|
+
**email_cc** | **Array<String>** | List of the email addresses of the recipients in cc | [optional]
|
9
|
+
**reply_to** | **String** | Email address which shall be used by campaign recipients to reply back | [optional]
|
10
10
|
**attachment_url** | **String** | Absolute url of the attachment (no local file). Extension allowed: 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 and eps | [optional]
|
11
|
-
**attachment** | [**Array<SendEmailAttachment>**](SendEmailAttachment.md) | Pass the
|
12
|
-
**headers** | **
|
13
|
-
**attributes** | **
|
11
|
+
**attachment** | [**Array<SendEmailAttachment>**](SendEmailAttachment.md) | Pass the list of content (base64 encoded) and name of the attachment. For example, [{'content':'base64 encoded content 1', 'name':'attcahment1'}, {'content':'base64 encoded content 2', 'name':'attcahment2'}]. | [optional]
|
12
|
+
**headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'X-Mailin-IP' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'X-Mailin-IP':'1.2.3.4'} | [optional]
|
13
|
+
**attributes** | **Object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'} | [optional]
|
14
|
+
**tags** | **Array<String>** | Tag your emails to find them more easily | [optional]
|
14
15
|
|
15
16
|
|
data/docs/SendEmailAttachment.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**content** | **String** | Base64 encoded chunk data of the attachment generated on the fly |
|
7
|
-
**name** | **String** | Required for content. Name of the attachment |
|
6
|
+
**content** | **String** | Base64 encoded chunk data of the attachment generated on the fly |
|
7
|
+
**name** | **String** | Required for content. Name of the attachment |
|
8
8
|
|
9
9
|
|
data/docs/SendSmtpEmail.md
CHANGED
@@ -4,16 +4,17 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**sender** | [**SendSmtpEmailSender**](SendSmtpEmailSender.md) | | [optional]
|
7
|
-
**to** | [**Array<SendSmtpEmailTo>**](SendSmtpEmailTo.md) |
|
8
|
-
**bcc** | [**Array<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) |
|
9
|
-
**cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) |
|
7
|
+
**to** | [**Array<SendSmtpEmailTo>**](SendSmtpEmailTo.md) | List of email addresses and names (optional) of the recipients. For example, [{'name':'Jimmy', 'email':'jimmy98@example.com'}, {'name':'Joe', 'email':'joe@example.com'}] |
|
8
|
+
**bcc** | [**Array<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional]
|
9
|
+
**cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional]
|
10
10
|
**html_content** | **String** | HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) | [optional]
|
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
|
15
|
-
**headers** | **
|
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':'My attachment 1'}, {'content':'base64 exmaple content', 'name':'My attachment 2'}]. 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 and eps ( Ignored if 'templateId' is passed ) | [optional]
|
15
|
+
**headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'X-Mailin-IP' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'X-Mailin-IP':'1.2.3.4'} | [optional]
|
16
16
|
**template_id** | **Integer** | Id of the template | [optional]
|
17
|
-
**params** | **
|
17
|
+
**params** | **Object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. | [optional]
|
18
|
+
**tags** | **Array<String>** | Tag your emails to find them more easily | [optional]
|
18
19
|
|
19
20
|
|
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**url** | **String** | Absolute url of the attachment (no local file). | [optional]
|
7
7
|
**content** | **String** | Base64 encoded chunk data of the attachment generated on the fly | [optional]
|
8
|
-
**name** | **String** | Required
|
8
|
+
**name** | **String** | Required if content is passed. Name of the attachment | [optional]
|
9
9
|
|
10
10
|
|
data/docs/SendSmtpEmailSender.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**name** | **String** |
|
7
|
-
**email** | **String** |
|
6
|
+
**name** | **String** | Name of the sender from which the emails will be sent | [optional]
|
7
|
+
**email** | **String** | Email of the sender from which the emails will be sent |
|
8
8
|
|
9
9
|
|
data/docs/SendTestEmail.md
CHANGED
@@ -3,6 +3,6 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**email_to** | **Array<String>** |
|
6
|
+
**email_to** | **Array<String>** | List of the email addresses of the recipients whom you wish to send the test mail. If left empty, the test mail will be sent to your entire test list. | [optional]
|
7
7
|
|
8
8
|
|
data/docs/UpdateAttribute.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**value** | **String** | Value of the attribute. Use only if the attribute's category is calculated or global | [optional]
|
7
|
-
**enumeration** | [**Array<UpdateAttributeEnumeration>**](UpdateAttributeEnumeration.md) |
|
6
|
+
**value** | **String** | Value of the attribute to update. Use only if the attribute's category is 'calculated' or 'global' | [optional]
|
7
|
+
**enumeration** | [**Array<UpdateAttributeEnumeration>**](UpdateAttributeEnumeration.md) | List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] | [optional]
|
8
8
|
|
9
9
|
|
data/docs/UpdateContact.md
CHANGED
@@ -3,9 +3,9 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**attributes** | **
|
7
|
-
**email_blacklisted** | **BOOLEAN** |
|
8
|
-
**sms_blacklisted** | **BOOLEAN** |
|
6
|
+
**attributes** | **Object** | Pass the set of attributes to be updated. These attributes must be present in your account. For eg. {'FNAME':'Ellie', 'LNAME':'Roger'} | [optional]
|
7
|
+
**email_blacklisted** | **BOOLEAN** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | [optional]
|
8
|
+
**sms_blacklisted** | **BOOLEAN** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional]
|
9
9
|
**list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional]
|
10
10
|
**unlink_list_ids** | **Array<Integer>** | Ids of the lists to remove the contact from | [optional]
|
11
11
|
**smtp_blacklist_sender** | **Array<String>** | SMTP forbidden sender for contact. Use only for email Contact | [optional]
|
data/docs/UpdateList.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**name** | **String** | Name of the list.
|
7
|
-
**folder_id** | **Integer** | Id of the folder in which to
|
6
|
+
**name** | **String** | Name of the list. Either of the two parameters (name, folderId) can be updated at a time. | [optional]
|
7
|
+
**folder_id** | **Integer** | Id of the folder in which the list is to be moved. Either of the two parameters (name, folderId) can be updated at a time. | [optional]
|
8
8
|
|
9
9
|
|
data/lib/sib-api-v3-sdk.rb
CHANGED
@@ -73,7 +73,6 @@ require 'sib-api-v3-sdk/models/get_email_event_report'
|
|
73
73
|
require 'sib-api-v3-sdk/models/get_email_event_report_events'
|
74
74
|
require 'sib-api-v3-sdk/models/get_extended_campaign_overview_sender'
|
75
75
|
require 'sib-api-v3-sdk/models/get_extended_campaign_stats'
|
76
|
-
require 'sib-api-v3-sdk/models/get_extended_campaign_stats_links_stats'
|
77
76
|
require 'sib-api-v3-sdk/models/get_extended_client_address'
|
78
77
|
require 'sib-api-v3-sdk/models/get_extended_contact_details_statistics'
|
79
78
|
require 'sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked'
|
@@ -515,7 +515,7 @@ module SibApiV3Sdk
|
|
515
515
|
end
|
516
516
|
|
517
517
|
# Send a template
|
518
|
-
#
|
518
|
+
# This endpoint is deprecated. Prefer v3/smtp/email instead.
|
519
519
|
# @param template_id Id of the template
|
520
520
|
# @param send_email
|
521
521
|
# @param [Hash] opts the optional parameters
|
@@ -526,7 +526,7 @@ module SibApiV3Sdk
|
|
526
526
|
end
|
527
527
|
|
528
528
|
# Send a template
|
529
|
-
#
|
529
|
+
# This endpoint is deprecated. Prefer v3/smtp/email instead.
|
530
530
|
# @param template_id Id of the template
|
531
531
|
# @param send_email
|
532
532
|
# @param [Hash] opts the optional parameters
|
@@ -15,13 +15,13 @@ require 'date'
|
|
15
15
|
module SibApiV3Sdk
|
16
16
|
|
17
17
|
class CreateAttribute
|
18
|
-
# Value of the attribute. Use only if the attribute's category is calculated or global
|
18
|
+
# Value of the attribute. Use only if the attribute's category is 'calculated' or 'global'
|
19
19
|
attr_accessor :value
|
20
20
|
|
21
|
-
#
|
21
|
+
# List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}]
|
22
22
|
attr_accessor :enumeration
|
23
23
|
|
24
|
-
# Type of the attribute. Use only if the attribute's category is normal, category or transactional ( type 'id' only available if the category is 'transactional' attribute & type 'category' only available if the category is 'category' attribute )
|
24
|
+
# Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute )
|
25
25
|
attr_accessor :type
|
26
26
|
|
27
27
|
class EnumAttributeValidator
|
@@ -15,22 +15,22 @@ require 'date'
|
|
15
15
|
module SibApiV3Sdk
|
16
16
|
|
17
17
|
class CreateContact
|
18
|
-
# Email address of the user. Mandatory if
|
18
|
+
# Email address of the user. Mandatory if \"sms\" field is not passed in \"attributes\" parameter'
|
19
19
|
attr_accessor :email
|
20
20
|
|
21
|
-
#
|
21
|
+
# Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'}
|
22
22
|
attr_accessor :attributes
|
23
23
|
|
24
|
-
#
|
24
|
+
# Set this field to blacklist the contact for emails (emailBlacklisted = true)
|
25
25
|
attr_accessor :email_blacklisted
|
26
26
|
|
27
|
-
#
|
27
|
+
# Set this field to blacklist the contact for SMS (smsBlacklisted = true)
|
28
28
|
attr_accessor :sms_blacklisted
|
29
29
|
|
30
30
|
# Ids of the lists to add the contact to
|
31
31
|
attr_accessor :list_ids
|
32
32
|
|
33
|
-
# Facilitate to update existing contact in same request (updateEnabled = true)
|
33
|
+
# Facilitate to update the existing contact in the same request (updateEnabled = true)
|
34
34
|
attr_accessor :update_enabled
|
35
35
|
|
36
36
|
# SMTP forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true )
|
@@ -13,7 +13,7 @@ Swagger Codegen version: 2.3.1
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module SibApiV3Sdk
|
16
|
-
|
16
|
+
# Sender details including email and name (optional). For example {'name':'xyz' , 'email':'example@abc.com'}
|
17
17
|
class CreateEmailCampaignSender
|
18
18
|
# Sender Name
|
19
19
|
attr_accessor :name
|
@@ -13,7 +13,7 @@ Swagger Codegen version: 2.3.1
|
|
13
13
|
require 'date'
|
14
14
|
|
15
15
|
module SibApiV3Sdk
|
16
|
-
|
16
|
+
# Sender details including email and name (optional). For example {'name':'xyz' , 'email':'example@abc.com'}
|
17
17
|
class CreateSmtpTemplateSender
|
18
18
|
# Name of the sender. If not passed, will be set to default
|
19
19
|
attr_accessor :name
|
@@ -15,10 +15,10 @@ require 'date'
|
|
15
15
|
module SibApiV3Sdk
|
16
16
|
|
17
17
|
class DeleteHardbounces
|
18
|
-
# Starting date (YYYY-MM-DD) of the period
|
18
|
+
# Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate
|
19
19
|
attr_accessor :start_date
|
20
20
|
|
21
|
-
# Ending date (YYYY-MM-DD) of the period
|
21
|
+
# Ending date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate
|
22
22
|
attr_accessor :end_date
|
23
23
|
|
24
24
|
# Target a specific email address
|
@@ -15,13 +15,13 @@ require 'date'
|
|
15
15
|
module SibApiV3Sdk
|
16
16
|
|
17
17
|
class GetCampaignStats
|
18
|
-
# List Id of email campaign (only in case of get email campaign(s))
|
18
|
+
# List Id of email campaign (only in case of get email campaign(s)(not for global stats))
|
19
19
|
attr_accessor :list_id
|
20
20
|
|
21
21
|
# Number of unique clicks for the campaign
|
22
22
|
attr_accessor :unique_clicks
|
23
23
|
|
24
|
-
# Number of clicks for the campaign
|
24
|
+
# Number of total clicks for the campaign
|
25
25
|
attr_accessor :clickers
|
26
26
|
|
27
27
|
# Number of complaints (Spam reports) for the campaign
|
@@ -190,10 +190,6 @@ module SibApiV3Sdk
|
|
190
190
|
invalid_properties.push("invalid value for 'viewed', viewed cannot be nil.")
|
191
191
|
end
|
192
192
|
|
193
|
-
if @deferred.nil?
|
194
|
-
invalid_properties.push("invalid value for 'deferred', deferred cannot be nil.")
|
195
|
-
end
|
196
|
-
|
197
193
|
return invalid_properties
|
198
194
|
end
|
199
195
|
|
@@ -210,7 +206,6 @@ module SibApiV3Sdk
|
|
210
206
|
return false if @unique_views.nil?
|
211
207
|
return false if @unsubscriptions.nil?
|
212
208
|
return false if @viewed.nil?
|
213
|
-
return false if @deferred.nil?
|
214
209
|
return true
|
215
210
|
end
|
216
211
|
|