Socket
Socket
Sign inDemoInstall

sib-api-v3-sdk

Package Overview
Dependencies
38
Maintainers
2
Versions
42
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

Comparing version 7.1.0 to 7.1.1

2

docs/CreateAttribute.md

@@ -7,3 +7,3 @@ # SibApiV3Sdk.CreateAttribute

**value** | **String** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional]
**enumeration** | [**[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]
**enumeration** | [**[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]
**type** | **String** | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [optional]

@@ -10,0 +10,0 @@

@@ -7,3 +7,3 @@ # SibApiV3Sdk.CreateContact

**email** | **String** | Email address of the user. Mandatory if \"sms\" field is not passed in \"attributes\" parameter' | [optional]
**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]
**attributes** | **Object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For example, `{\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"}` | [optional]
**emailBlacklisted** | **Boolean** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional]

@@ -10,0 +10,0 @@ **smsBlacklisted** | **Boolean** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional]

@@ -13,5 +13,5 @@ # SibApiV3Sdk.CreateEmailCampaign

**scheduledAt** | **Date** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional]
**subject** | **String** | Subject of the campaign |
**subject** | **String** | Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. | [optional]
**replyTo** | **String** | Email on which the campaign recipients will be able to reply to | [optional]
**toField** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional]
**toField** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization | [optional]
**recipients** | [**CreateEmailCampaignRecipients**](CreateEmailCampaignRecipients.md) | | [optional]

@@ -24,5 +24,22 @@ **attachmentUrl** | **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]

**utmCampaign** | **String** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional]
**params** | **Object** | Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional]
**params** | **Object** | Pass the set of attributes to customize the type classic campaign. For example, `{\"FNAME\":\"Joe\", \"LNAME:\"Doe\"}`. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional]
**sendAtBestTime** | **Boolean** | Set this to true if you want to send your campaign at best time. | [optional] [default to false]
**abTesting** | **Boolean** | Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B | [optional] [default to false]
**subjectA** | **String** | Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional]
**subjectB** | **String** | Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional]
**splitRule** | **Number** | Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else | [optional]
**winnerCriteria** | **String** | Choose the metrics that will determinate the winning version. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed | [optional]
**winnerDelay** | **Number** | Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed | [optional]
<a name="WinnerCriteriaEnum"></a>
## Enum: WinnerCriteriaEnum
* `open` (value: `"open"`)
* `click` (value: `"click"`)

@@ -13,3 +13,3 @@ # SibApiV3Sdk.CreateSmtpTemplate

**replyTo** | **String** | Email on which campaign recipients will be able to reply to | [optional]
**toField** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter &#39;params&#39; used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional]
**toField** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add &#x60;{FNAME} {LNAME}&#x60;. These contact attributes must already exist in your SendinBlue account. If input parameter &#39;params&#39; used please use &#x60;{{contact.FNAME}} {{contact.LNAME}}&#x60; for personalization | [optional]
**attachmentUrl** | **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]

@@ -16,0 +16,0 @@ **isActive** | **Boolean** | Status of template. isActive &#x3D; true means template is active and isActive &#x3D; false means template is inactive | [optional]

@@ -8,6 +8,13 @@ # SibApiV3Sdk.GetCampaignOverview

**name** | **String** | Name of the campaign |
**subject** | **String** | Subject of the campaign |
**subject** | **String** | Subject of the campaign. Only available if &#x60;abTesting&#x60; flag of the campaign is &#x60;false&#x60; | [optional]
**type** | **String** | Type of campaign |
**status** | **String** | Status of the campaign |
**scheduledAt** | **Date** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
**abTesting** | **Boolean** | Status of A/B Test for the campaign. abTesting &#x3D; false means it is disabled, &amp; abTesting &#x3D; true means it is enabled. | [optional]
**subjectA** | **String** | Subject A of the ab-test campaign. Only available if &#x60;abTesting&#x60; flag of the campaign is &#x60;true&#x60; | [optional]
**subjectB** | **String** | Subject B of the ab-test campaign. Only available if &#x60;abTesting&#x60; flag of the campaign is &#x60;true&#x60; | [optional]
**splitRule** | **Number** | The size of your ab-test groups. Only available if &#x60;abTesting&#x60; flag of the campaign is &#x60;true&#x60; | [optional]
**winnerCriteria** | **String** | Criteria for the winning version. Only available if &#x60;abTesting&#x60; flag of the campaign is &#x60;true&#x60; | [optional]
**winnerDelay** | **Number** | The duration of the test in hours at the end of which the winning version will be sent. Only available if &#x60;abTesting&#x60; flag of the campaign is &#x60;true&#x60; | [optional]
**sendAtBestTime** | **Boolean** | It is true if you have chosen to send your campaign at best time, otherwise it is false | [optional]

@@ -14,0 +21,0 @@

@@ -7,5 +7,5 @@ # SibApiV3Sdk.RequestContactExport

**exportAttributes** | **[String]** | List of all the attributes that you want to export. These attributes must be present in your contact database. For example, [&#39;fname&#39;, &#39;lname&#39;, &#39;email&#39;]. | [optional]
**contactFilter** | **Object** | Set the filter for the contacts to be exported. For example, {&#39;blacklisted&#39;:true} will export all the blacklisted contacts. |
**contactFilter** | **Object** | Set the filter for the contacts to be exported. For example, &#x60;{\&quot;blacklisted\&quot;:true}&#x60; will export all the blacklisted contacts. |
**notifyUrl** | **String** | Webhook that will be called once the export process is finished | [optional]

@@ -11,7 +11,7 @@ # SibApiV3Sdk.SendEmail

**attachmentUrl** | **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]
**attachment** | [**[SendEmailAttachment]**](SendEmailAttachment.md) | Pass the list of content (base64 encoded) and name of the attachment. For example, [{&#39;content&#39;:&#39;base64 encoded content 1&#39;, &#39;name&#39;:&#39;attcahment1&#39;}, {&#39;content&#39;:&#39;base64 encoded content 2&#39;, &#39;name&#39;:&#39;attcahment2&#39;}]. | [optional]
**headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. &#39;sender.ip&#39; header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {&#39;Content-Type&#39;:&#39;text/html&#39;, &#39;charset&#39;:&#39;iso-8859-1&#39;, &#39;sender.ip&#39;:&#39;1.2.3.4&#39;} | [optional]
**attributes** | **Object** | Pass the set of attributes to customize the template. For example, {&#39;FNAME&#39;:&#39;Joe&#39;, &#39;LNAME&#39;:&#39;Doe&#39;} | [optional]
**attachment** | [**[SendEmailAttachment]**](SendEmailAttachment.md) | Pass the list of content (base64 encoded) and name of the attachment. For example, &#x60;[{\&quot;content\&quot;:\&quot;base64 encoded content 1\&quot;, \&quot;name\&quot;:\&quot;attcahment1\&quot;}, {\&quot;content\&quot;:\&quot;base64 encoded content 2\&quot;, \&quot;name\&quot;:\&quot;attcahment2\&quot;}]&#x60; | [optional]
**headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. &#39;sender.ip&#39; header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, &#x60;{\&quot;Content-Type\&quot;:\&quot;text/html\&quot;, \&quot;charset\&quot;:\&quot;iso-8859-1\&quot;, \&quot;sender.ip\&quot;:\&quot;1.2.3.4\&quot;}&#x60; | [optional]
**attributes** | **Object** | Pass the set of attributes to customize the template. For example, {\&quot;FNAME\&quot;:\&quot;Joe\&quot;, \&quot;LNAME\&quot;:\&quot;Doe\&quot;} | [optional]
**tags** | **[String]** | Tag your emails to find them more easily | [optional]

@@ -7,3 +7,3 @@ # SibApiV3Sdk.SendSmtpEmail

**sender** | [**SendSmtpEmailSender**](SendSmtpEmailSender.md) | | [optional]
**to** | [**[SendSmtpEmailTo]**](SendSmtpEmailTo.md) | List of email addresses and names (optional) of the recipients. For example, [{&#39;name&#39;:&#39;Jimmy&#39;, &#39;email&#39;:&#39;jimmy98@example.com&#39;}, {&#39;name&#39;:&#39;Joe&#39;, &#39;email&#39;:&#39;joe@example.com&#39;}] |
**to** | [**[SendSmtpEmailTo]**](SendSmtpEmailTo.md) | List of email addresses and names (optional) of the recipients. For example, &#x60;[{\&quot;name\&quot;:\&quot;Jimmy\&quot;, \&quot;email\&quot;:\&quot;jimmy98@example.com\&quot;}, {\&quot;name\&quot;:\&quot;Joe\&quot;, \&quot;email\&quot;:\&quot;joe@example.com\&quot;}]&#x60; |
**bcc** | [**[SendSmtpEmailBcc]**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional]

@@ -15,8 +15,8 @@ **cc** | [**[SendSmtpEmailCc]**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional]

**replyTo** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
**attachment** | [**[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, [{&#39;url&#39;:&#39;https://attachment.domain.com/myAttachmentFromUrl.jpg&#39;, &#39;name&#39;:&#39;My attachment 1&#39;}, {&#39;content&#39;:&#39;base64 exmaple content&#39;, &#39;name&#39;:&#39;My attachment 2&#39;}]. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps and odt ( If &#39;templateId&#39; is passed and is in New Template Language format then only attachment url is accepted. If template is in Old template Language format, then &#39;attachment&#39; is ignored ) | [optional]
**headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. &#39;sender.ip&#39; header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {&#39;Content-Type&#39;:&#39;text/html&#39;, &#39;charset&#39;:&#39;iso-8859-1&#39;, &#39;sender.ip&#39;:&#39;1.2.3.4&#39;} | [optional]
**attachment** | [**[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, &#x60;[{\&quot;url\&quot;:\&quot;https://attachment.domain.com/myAttachmentFromUrl.jpg\&quot;, \&quot;name\&quot;:\&quot;My attachment 1\&quot;}, {\&quot;content\&quot;:\&quot;base64 exmaple content\&quot;, \&quot;name\&quot;:\&quot;My attachment 2\&quot;}]&#x60;. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps and odt ( If &#39;templateId&#39; is passed and is in New Template Language format then only attachment url is accepted. If template is in Old template Language format, then &#39;attachment&#39; is ignored ) | [optional]
**headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. &#39;sender.ip&#39; header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, &#x60;{\&quot;Content-Type\&quot;:\&quot;text/html\&quot;, \&quot;charset\&quot;:\&quot;iso-8859-1\&quot;, \&quot;sender.ip\&quot;:\&quot;1.2.3.4\&quot;}&#x60; | [optional]
**templateId** | **Number** | Id of the template | [optional]
**params** | **Object** | Pass the set of attributes to customize the template. For example, {&#39;FNAME&#39;:&#39;Joe&#39;, &#39;LNAME&#39;:&#39;Doe&#39;}. It&#39;s considered only if template is in New Template Language format. | [optional]
**params** | **Object** | Pass the set of attributes to customize the template. For example, &#x60;{\&quot;FNAME\&quot;:\&quot;Joe\&quot;, \&quot;LNAME\&quot;:\&quot;Doe\&quot;}&#x60;. It&#39;s considered only if template is in New Template Language format. | [optional]
**tags** | **[String]** | Tag your emails to find them more easily | [optional]

@@ -7,4 +7,4 @@ # SibApiV3Sdk.UpdateAttribute

**value** | **String** | Value of the attribute to update. Use only if the attribute&#39;s category is &#39;calculated&#39; or &#39;global&#39; | [optional]
**enumeration** | [**[UpdateAttributeEnumeration]**](UpdateAttributeEnumeration.md) | List of the values and labels that the attribute can take. Use only if the attribute&#39;s category is \&quot;category\&quot;. For example, [{&#39;value&#39;:1, &#39;label&#39;:&#39;male&#39;}, {&#39;value&#39;:2, &#39;label&#39;:&#39;female&#39;}] | [optional]
**enumeration** | [**[UpdateAttributeEnumeration]**](UpdateAttributeEnumeration.md) | List of the values and labels that the attribute can take. Use only if the attribute&#39;s category is \&quot;category\&quot;. For example, &#x60;[{\&quot;value\&quot;:1, \&quot;label\&quot;:\&quot;male\&quot;}, {\&quot;value\&quot;:2, \&quot;label\&quot;:\&quot;female\&quot;}]&#x60; | [optional]

@@ -6,3 +6,3 @@ # SibApiV3Sdk.UpdateContact

------------ | ------------- | ------------- | -------------
**attributes** | **Object** | Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For eg. { &#39;EMAIL&#39;:&#39;newemail@domain.com&#39;, &#39;FNAME&#39;:&#39;Ellie&#39;, &#39;LNAME&#39;:&#39;Roger&#39;} | [optional]
**attributes** | **Object** | Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, &#x60;{ &#39;EMAIL&#39;:&#39;newemail@domain.com&#39;, &#39;FNAME&#39;:&#39;Ellie&#39;, &#39;LNAME&#39;:&#39;Roger&#39;}&#x60; | [optional]
**emailBlacklisted** | **Boolean** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted &#x3D; true) | [optional]

@@ -9,0 +9,0 @@ **smsBlacklisted** | **Boolean** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted &#x3D; true) | [optional]

@@ -14,3 +14,3 @@ # SibApiV3Sdk.UpdateEmailCampaign

**replyTo** | **String** | Email on which campaign recipients will be able to reply to | [optional]
**toField** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter &#39;params&#39; used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional]
**toField** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add &#x60;{FNAME} {LNAME}&#x60;. These contact attributes must already exist in your SendinBlue account. If input parameter &#39;params&#39; used please use &#x60;{{contact.FNAME}} {{contact.LNAME}}&#x60; for personalization | [optional]
**recipients** | [**UpdateEmailCampaignRecipients**](UpdateEmailCampaignRecipients.md) | | [optional]

@@ -24,5 +24,22 @@ **attachmentUrl** | **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]

**utmCampaign** | **String** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional]
**params** | **Object** | Pass the set of attributes to customize the type &#39;classic&#39; campaign. For example, {&#39;FNAME&#39;:&#39;Joe&#39;, &#39;LNAME&#39;:&#39;Doe&#39;}. The &#39;params&#39; field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of &#39;subject&#39;, &#39;htmlContent/htmlUrl&#39;, &#39;sender.name&#39; &amp; &#39;toField&#39; | [optional]
**params** | **Object** | Pass the set of attributes to customize the type &#39;classic&#39; campaign. For example, &#x60;{\&quot;FNAME\&quot;:\&quot;Joe\&quot;, \&quot;LNAME\&quot;:\&quot;Doe\&quot;}&#x60;. The &#39;params&#39; field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of &#39;subject&#39;, &#39;htmlContent/htmlUrl&#39;, &#39;sender.name&#39; &amp; &#39;toField&#39; | [optional]
**sendAtBestTime** | **Boolean** | Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled. | [optional]
**abTesting** | **Boolean** | Status of A/B Test. abTesting &#x3D; false means it is disabled, &amp; abTesting &#x3D; true means it is enabled. &#39;subjectA&#39;, &#39;subjectB&#39;, &#39;splitRule&#39;, &#39;winnerCriteria&#39; &amp; &#39;winnerDelay&#39; will be considered if abTesting is set to true. &#39;subject&#39; if passed is ignored. Can be set to true only if &#39;sendAtBestTime&#39; is &#39;false&#39;. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B | [optional] [default to false]
**subjectA** | **String** | Subject A of the campaign. Considered if abTesting &#x3D; true. subjectA &amp; subjectB should have unique value | [optional]
**subjectB** | **String** | Subject B of the campaign. Considered if abTesting &#x3D; true. subjectA &amp; subjectB should have unique value | [optional]
**splitRule** | **Number** | Add the size of your test groups. Considered if abTesting &#x3D; true. We&#39;ll send version A and B to a random sample of recipients, and then the winning version to everyone else | [optional]
**winnerCriteria** | **String** | Choose the metrics that will determinate the winning version. Considered if &#39;splitRule&#39; &gt;&#x3D; 1 and &lt; 50. If splitRule &#x3D; 50, &#39;winnerCriteria&#39; is ignored if passed or alreday exist in record | [optional]
**winnerDelay** | **Number** | Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 &#x3D; 168 hours. The winning version will be sent at the end of the test. Considered if &#39;splitRule&#39; &gt;&#x3D; 1 and &lt; 50. If splitRule &#x3D; 50, &#39;winnerDelay&#39; is ignored if passed or alreday exist in record | [optional]
<a name="WinnerCriteriaEnum"></a>
## Enum: WinnerCriteriaEnum
* `open` (value: `"open"`)
* `click` (value: `"click"`)

@@ -13,3 +13,3 @@ # SibApiV3Sdk.UpdateSmtpTemplate

**replyTo** | **String** | Email on which campaign recipients will be able to reply to | [optional]
**toField** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter &#39;params&#39; used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional]
**toField** | **String** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add &#x60;{FNAME} {LNAME}&#x60;. These contact attributes must already exist in your SendinBlue account. If input parameter &#39;params&#39; used please use &#x60;{{contact.FNAME}} {{contact.LNAME}}&#x60; for personalization | [optional]
**attachmentUrl** | **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]

@@ -16,0 +16,0 @@ **isActive** | **Boolean** | Status of the template. isActive &#x3D; false means template is inactive, isActive &#x3D; true means template is active | [optional]

{
"name": "sib-api-v3-sdk",
"version": "7.1.0",
"version": "7.1.1",
"description": "Official SendinBlue provided RESTFul API V3 nodejs library",

@@ -5,0 +5,0 @@ "license": "ISC",

@@ -86,3 +86,3 @@ /**

/**
* 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'}]
* 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\"}]`
* @member {Array.<module:model/CreateAttributeEnumeration>} enumeration

@@ -89,0 +89,0 @@ */

@@ -102,3 +102,3 @@ /**

/**
* Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'}
* Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For example, `{\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"}`
* @member {Object} attributes

@@ -105,0 +105,0 @@ */

@@ -49,5 +49,4 @@ /**

* @param name {String} Name of the campaign
* @param subject {String} Subject of the campaign
*/
var exports = function(sender, name, subject) {
var exports = function(sender, name) {
var _this = this;

@@ -62,3 +61,2 @@

_this['subject'] = subject;

@@ -75,2 +73,9 @@

};

@@ -146,2 +151,20 @@

}
if (data.hasOwnProperty('abTesting')) {
obj['abTesting'] = ApiClient.convertToType(data['abTesting'], 'Boolean');
}
if (data.hasOwnProperty('subjectA')) {
obj['subjectA'] = ApiClient.convertToType(data['subjectA'], 'String');
}
if (data.hasOwnProperty('subjectB')) {
obj['subjectB'] = ApiClient.convertToType(data['subjectB'], 'String');
}
if (data.hasOwnProperty('splitRule')) {
obj['splitRule'] = ApiClient.convertToType(data['splitRule'], 'Number');
}
if (data.hasOwnProperty('winnerCriteria')) {
obj['winnerCriteria'] = ApiClient.convertToType(data['winnerCriteria'], 'String');
}
if (data.hasOwnProperty('winnerDelay')) {
obj['winnerDelay'] = ApiClient.convertToType(data['winnerDelay'], 'Number');
}
}

@@ -186,3 +209,3 @@ return obj;

/**
* Subject of the campaign
* Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true.
* @member {String} subject

@@ -197,3 +220,3 @@ */

/**
* To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
* To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization
* @member {String} toField

@@ -238,3 +261,3 @@ */

/**
* Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField'
* Pass the set of attributes to customize the type classic campaign. For example, `{\"FNAME\":\"Joe\", \"LNAME:\"Doe\"}`. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField'
* @member {Object} params

@@ -249,5 +272,53 @@ */

exports.prototype['sendAtBestTime'] = false;
/**
* Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B
* @member {Boolean} abTesting
* @default false
*/
exports.prototype['abTesting'] = false;
/**
* Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value
* @member {String} subjectA
*/
exports.prototype['subjectA'] = undefined;
/**
* Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value
* @member {String} subjectB
*/
exports.prototype['subjectB'] = undefined;
/**
* Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else
* @member {Number} splitRule
*/
exports.prototype['splitRule'] = undefined;
/**
* Choose the metrics that will determinate the winning version. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed
* @member {module:model/CreateEmailCampaign.WinnerCriteriaEnum} winnerCriteria
*/
exports.prototype['winnerCriteria'] = undefined;
/**
* Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed
* @member {Number} winnerDelay
*/
exports.prototype['winnerDelay'] = undefined;
/**
* Allowed values for the <code>winnerCriteria</code> property.
* @enum {String}
* @readonly
*/
exports.WinnerCriteriaEnum = {
/**
* value: "open"
* @const
*/
"open": "open",
/**
* value: "click"
* @const
*/
"click": "click" };
return exports;

@@ -254,0 +325,0 @@ }));

@@ -45,3 +45,3 @@ /**

* Constructs a new <code>CreateEmailCampaignSender</code>.
* Sender details including email and name (optional). For example {&#39;name&#39;:&#39;xyz&#39; , &#39;email&#39;:&#39;example@abc.com&#39;}
* Sender details including email and name (optional). For example &#x60;{\&quot;name\&quot;:\&quot;xyz\&quot;, \&quot;email\&quot;:\&quot;example@abc.com\&quot;}&#x60;
* @alias module:model/CreateEmailCampaignSender

@@ -48,0 +48,0 @@ * @class

@@ -146,3 +146,3 @@ /**

/**
* To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
* To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization
* @member {String} toField

@@ -149,0 +149,0 @@ */

@@ -45,3 +45,3 @@ /**

* Constructs a new <code>CreateSmtpTemplateSender</code>.
* Sender details including email and name (optional). For example {&#39;name&#39;:&#39;xyz&#39; , &#39;email&#39;:&#39;example@abc.com&#39;}
* Sender details including email and name (optional). For example &#x60;{\&quot;name\&quot;:\&quot;xyz\&quot;, \&quot;email\&quot;:\&quot;example@abc.com\&quot;}&#x60;
* @alias module:model/CreateSmtpTemplateSender

@@ -48,0 +48,0 @@ * @class

@@ -49,7 +49,6 @@ /**

* @param name {String} Name of the campaign
* @param subject {String} Subject of the campaign
* @param type {module:model/GetCampaignOverview.TypeEnum} Type of campaign
* @param status {module:model/GetCampaignOverview.StatusEnum} Status of the campaign
*/
var exports = function(id, name, subject, type, status) {
var exports = function(id, name, type, status) {
var _this = this;

@@ -59,6 +58,13 @@

_this['name'] = name;
_this['subject'] = subject;
_this['type'] = type;
_this['status'] = status;
};

@@ -95,2 +101,23 @@

}
if (data.hasOwnProperty('abTesting')) {
obj['abTesting'] = ApiClient.convertToType(data['abTesting'], 'Boolean');
}
if (data.hasOwnProperty('subjectA')) {
obj['subjectA'] = ApiClient.convertToType(data['subjectA'], 'String');
}
if (data.hasOwnProperty('subjectB')) {
obj['subjectB'] = ApiClient.convertToType(data['subjectB'], 'String');
}
if (data.hasOwnProperty('splitRule')) {
obj['splitRule'] = ApiClient.convertToType(data['splitRule'], 'Number');
}
if (data.hasOwnProperty('winnerCriteria')) {
obj['winnerCriteria'] = ApiClient.convertToType(data['winnerCriteria'], 'String');
}
if (data.hasOwnProperty('winnerDelay')) {
obj['winnerDelay'] = ApiClient.convertToType(data['winnerDelay'], 'Number');
}
if (data.hasOwnProperty('sendAtBestTime')) {
obj['sendAtBestTime'] = ApiClient.convertToType(data['sendAtBestTime'], 'Boolean');
}
}

@@ -111,3 +138,3 @@ return obj;

/**
* Subject of the campaign
* Subject of the campaign. Only available if `abTesting` flag of the campaign is `false`
* @member {String} subject

@@ -131,2 +158,37 @@ */

exports.prototype['scheduledAt'] = undefined;
/**
* Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled.
* @member {Boolean} abTesting
*/
exports.prototype['abTesting'] = undefined;
/**
* Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
* @member {String} subjectA
*/
exports.prototype['subjectA'] = undefined;
/**
* Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
* @member {String} subjectB
*/
exports.prototype['subjectB'] = undefined;
/**
* The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true`
* @member {Number} splitRule
*/
exports.prototype['splitRule'] = undefined;
/**
* Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true`
* @member {String} winnerCriteria
*/
exports.prototype['winnerCriteria'] = undefined;
/**
* The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true`
* @member {Number} winnerDelay
*/
exports.prototype['winnerDelay'] = undefined;
/**
* It is true if you have chosen to send your campaign at best time, otherwise it is false
* @member {Boolean} sendAtBestTime
*/
exports.prototype['sendAtBestTime'] = undefined;

@@ -133,0 +195,0 @@

@@ -50,3 +50,2 @@ /**

* @param name {String} Name of the campaign
* @param subject {String} Subject of the campaign
* @param type {module:model/GetCampaignOverview.TypeEnum} Type of campaign

@@ -67,6 +66,6 @@ * @param status {module:model/GetCampaignOverview.StatusEnum} Status of the campaign

*/
var exports = function(id, name, subject, type, status, testSent, header, footer, sender, replyTo, toField, htmlContent, tag, createdAt, modifiedAt, recipients, statistics) {
var exports = function(id, name, type, status, testSent, header, footer, sender, replyTo, toField, htmlContent, tag, createdAt, modifiedAt, recipients, statistics) {
var _this = this;
GetExtendedCampaignOverview.call(_this, id, name, subject, type, status, testSent, header, footer, sender, replyTo, toField, htmlContent, tag, createdAt, modifiedAt);
GetExtendedCampaignOverview.call(_this, id, name, type, status, testSent, header, footer, sender, replyTo, toField, htmlContent, tag, createdAt, modifiedAt);
_this['recipients'] = recipients;

@@ -121,3 +120,3 @@ _this['statistics'] = statistics;

/**
* Subject of the campaign
* Subject of the campaign. Only available if `abTesting` flag of the campaign is `false`
* @member {String} subject

@@ -146,2 +145,44 @@ */

/**
* Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled.
* @member {Boolean} abTesting
*/
exports.prototype['abTesting'] = undefined;
/**
* Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
* @member {String} subjectA
*/
exports.prototype['subjectA'] = undefined;
/**
* Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
* @member {String} subjectB
*/
exports.prototype['subjectB'] = undefined;
/**
* The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true`
* @member {Number} splitRule
*/
exports.prototype['splitRule'] = undefined;
/**
* Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true`
* @member {String} winnerCriteria
*/
exports.prototype['winnerCriteria'] = undefined;
/**
* The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true`
* @member {Number} winnerDelay
*/
exports.prototype['winnerDelay'] = undefined;
/**
* It is true if you have chosen to send your campaign at best time, otherwise it is false
* @member {Boolean} sendAtBestTime
*/
exports.prototype['sendAtBestTime'] = undefined;
/**
* Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent)

@@ -148,0 +189,0 @@ * @member {Boolean} testSent

@@ -50,3 +50,2 @@ /**

* @param name {String} Name of the campaign
* @param subject {String} Subject of the campaign
* @param type {module:model/GetCampaignOverview.TypeEnum} Type of campaign

@@ -65,6 +64,6 @@ * @param status {module:model/GetCampaignOverview.StatusEnum} Status of the campaign

*/
var exports = function(id, name, subject, type, status, testSent, header, footer, sender, replyTo, toField, htmlContent, tag, createdAt, modifiedAt) {
var exports = function(id, name, type, status, testSent, header, footer, sender, replyTo, toField, htmlContent, tag, createdAt, modifiedAt) {
var _this = this;
GetCampaignOverview.call(_this, id, name, subject, type, status);
GetCampaignOverview.call(_this, id, name, type, status);
_this['testSent'] = testSent;

@@ -237,3 +236,3 @@ _this['header'] = header;

/**
* Subject of the campaign
* Subject of the campaign. Only available if `abTesting` flag of the campaign is `false`
* @member {String} subject

@@ -261,4 +260,46 @@ */

/**
* Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled.
* @member {Boolean} abTesting
*/
exports.prototype['abTesting'] = undefined;
/**
* Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
* @member {String} subjectA
*/
exports.prototype['subjectA'] = undefined;
/**
* Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
* @member {String} subjectB
*/
exports.prototype['subjectB'] = undefined;
/**
* The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true`
* @member {Number} splitRule
*/
exports.prototype['splitRule'] = undefined;
/**
* Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true`
* @member {String} winnerCriteria
*/
exports.prototype['winnerCriteria'] = undefined;
/**
* The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true`
* @member {Number} winnerDelay
*/
exports.prototype['winnerDelay'] = undefined;
/**
* It is true if you have chosen to send your campaign at best time, otherwise it is false
* @member {Boolean} sendAtBestTime
*/
exports.prototype['sendAtBestTime'] = undefined;
return exports;

@@ -265,0 +306,0 @@ }));

@@ -47,3 +47,3 @@ /**

* @class
* @param contactFilter {Object} Set the filter for the contacts to be exported. For example, {'blacklisted':true} will export all the blacklisted contacts.
* @param contactFilter {Object} Set the filter for the contacts to be exported. For example, `{\"blacklisted\":true}` will export all the blacklisted contacts.
*/

@@ -88,3 +88,3 @@ var exports = function(contactFilter) {

/**
* Set the filter for the contacts to be exported. For example, {'blacklisted':true} will export all the blacklisted contacts.
* Set the filter for the contacts to be exported. For example, `{\"blacklisted\":true}` will export all the blacklisted contacts.
* @member {Object} contactFilter

@@ -91,0 +91,0 @@ */

@@ -131,3 +131,3 @@ /**

/**
* 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'}].
* 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\"}]`
* @member {Array.<module:model/SendEmailAttachment>} attachment

@@ -137,3 +137,3 @@ */

/**
* Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'}
* Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, `{\"Content-Type\":\"text/html\", \"charset\":\"iso-8859-1\", \"sender.ip\":\"1.2.3.4\"}`
* @member {Object} headers

@@ -143,3 +143,3 @@ */

/**
* Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}
* Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}
* @member {Object} attributes

@@ -146,0 +146,0 @@ */

@@ -47,3 +47,3 @@ /**

* @class
* @param to {Array.<module:model/SendSmtpEmailTo>} List of email addresses and names (optional) of the recipients. For example, [{'name':'Jimmy', 'email':'jimmy98@example.com'}, {'name':'Joe', 'email':'joe@example.com'}]
* @param to {Array.<module:model/SendSmtpEmailTo>} List of email addresses and names (optional) of the recipients. For example, `[{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}]`
*/

@@ -127,3 +127,3 @@ var exports = function(to) {

/**
* List of email addresses and names (optional) of the recipients. For example, [{'name':'Jimmy', 'email':'jimmy98@example.com'}, {'name':'Joe', 'email':'joe@example.com'}]
* List of email addresses and names (optional) of the recipients. For example, `[{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}]`
* @member {Array.<module:model/SendSmtpEmailTo>} to

@@ -162,3 +162,3 @@ */

/**
* 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, eps and odt ( If 'templateId' is passed and is in New Template Language format then only attachment url is accepted. If template is in Old template Language format, then 'attachment' is ignored )
* 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, eps and odt ( If 'templateId' is passed and is in New Template Language format then only attachment url is accepted. If template is in Old template Language format, then 'attachment' is ignored )
* @member {Array.<module:model/SendSmtpEmailAttachment>} attachment

@@ -168,3 +168,3 @@ */

/**
* Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'}
* Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, `{\"Content-Type\":\"text/html\", \"charset\":\"iso-8859-1\", \"sender.ip\":\"1.2.3.4\"}`
* @member {Object} headers

@@ -179,3 +179,3 @@ */

/**
* Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. It's considered only if template is in New Template Language format.
* Pass the set of attributes to customize the template. For example, `{\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}`. It's considered only if template is in New Template Language format.
* @member {Object} params

@@ -182,0 +182,0 @@ */

@@ -45,3 +45,3 @@ /**

* Constructs a new <code>SendSmtpEmailReplyTo</code>.
* Email (required), along with name (optional), on which transactional mail recipients will be able to reply back. For example, {&#39;email&#39;:&#39;ann6533@example.com&#39;, &#39;name&#39;:&#39;Ann&#39;}.
* Email (required), along with name (optional), on which transactional mail recipients will be able to reply back. For example, &#x60;{\&quot;email&#39;:&#39;ann6533@example.com&#39;, &#39;name&#39;:&#39;Ann&#39;}&#x60;
* @alias module:model/SendSmtpEmailReplyTo

@@ -48,0 +48,0 @@ * @class

@@ -45,3 +45,3 @@ /**

* Constructs a new <code>SendSmtpEmailSender</code>.
* Mandatory if &#39;templateId&#39; is not passed. Pass name (optional) and email of sender from which emails will be sent. For example, {&#39;name&#39;:&#39;Mary from MyShop&#39;, &#39;email&#39;:&#39;no-reply@myshop.com&#39;}
* Mandatory if &#39;templateId&#39; is not passed. Pass name (optional) and email of sender from which emails will be sent. For example, &#x60;{\&quot;name\&quot;:\&quot;Mary from MyShop\&quot;, \&quot;email\&quot;:\&quot;no-reply@myshop.com\&quot;}&#x60;
* @alias module:model/SendSmtpEmailSender

@@ -48,0 +48,0 @@ * @class

@@ -82,3 +82,3 @@ /**

/**
* 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'}]
* 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\"}]`
* @member {Array.<module:model/UpdateAttributeEnumeration>} enumeration

@@ -85,0 +85,0 @@ */

@@ -93,3 +93,3 @@ /**

/**
* Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For eg. { 'EMAIL':'newemail@domain.com', 'FNAME':'Ellie', 'LNAME':'Roger'}
* Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For eg. `{\"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`
* @member {Object} attributes

@@ -96,0 +96,0 @@ */

@@ -70,2 +70,8 @@ /**

};

@@ -141,2 +147,20 @@

}
if (data.hasOwnProperty('abTesting')) {
obj['abTesting'] = ApiClient.convertToType(data['abTesting'], 'Boolean');
}
if (data.hasOwnProperty('subjectA')) {
obj['subjectA'] = ApiClient.convertToType(data['subjectA'], 'String');
}
if (data.hasOwnProperty('subjectB')) {
obj['subjectB'] = ApiClient.convertToType(data['subjectB'], 'String');
}
if (data.hasOwnProperty('splitRule')) {
obj['splitRule'] = ApiClient.convertToType(data['splitRule'], 'Number');
}
if (data.hasOwnProperty('winnerCriteria')) {
obj['winnerCriteria'] = ApiClient.convertToType(data['winnerCriteria'], 'String');
}
if (data.hasOwnProperty('winnerDelay')) {
obj['winnerDelay'] = ApiClient.convertToType(data['winnerDelay'], 'Number');
}
}

@@ -186,3 +210,3 @@ return obj;

/**
* To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
* To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization
* @member {String} toField

@@ -233,3 +257,3 @@ */

/**
* Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField'
* Pass the set of attributes to customize the type 'classic' campaign. For example, `{\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}`. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField'
* @member {Object} params

@@ -243,5 +267,53 @@ */

exports.prototype['sendAtBestTime'] = undefined;
/**
* Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered if abTesting is set to true. 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B
* @member {Boolean} abTesting
* @default false
*/
exports.prototype['abTesting'] = false;
/**
* Subject A of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value
* @member {String} subjectA
*/
exports.prototype['subjectA'] = undefined;
/**
* Subject B of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value
* @member {String} subjectB
*/
exports.prototype['subjectB'] = undefined;
/**
* Add the size of your test groups. Considered if abTesting = true. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else
* @member {Number} splitRule
*/
exports.prototype['splitRule'] = undefined;
/**
* Choose the metrics that will determinate the winning version. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed or alreday exist in record
* @member {module:model/UpdateEmailCampaign.WinnerCriteriaEnum} winnerCriteria
*/
exports.prototype['winnerCriteria'] = undefined;
/**
* Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed or alreday exist in record
* @member {Number} winnerDelay
*/
exports.prototype['winnerDelay'] = undefined;
/**
* Allowed values for the <code>winnerCriteria</code> property.
* @enum {String}
* @readonly
*/
exports.WinnerCriteriaEnum = {
/**
* value: "open"
* @const
*/
"open": "open",
/**
* value: "click"
* @const
*/
"click": "click" };
return exports;

@@ -248,0 +320,0 @@ }));

@@ -45,3 +45,3 @@ /**

* Constructs a new <code>UpdateEmailCampaignSender</code>.
* Sender details including email and/or name. For example {&#39;name&#39;:&#39;xyz&#39; , &#39;email&#39;:&#39;example@abc.com&#39;}
* Sender details including email and/or name. For example &#x60;{\&quot;name\&quot;:\&quot;xyz\&quot;, \&quot;email\&quot;:\&quot;example@abc.com\&quot;}&#x60;
* @alias module:model/UpdateEmailCampaignSender

@@ -48,0 +48,0 @@ * @class

@@ -143,3 +143,3 @@ /**

/**
* To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
* To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization
* @member {String} toField

@@ -146,0 +146,0 @@ */

@@ -45,3 +45,3 @@ /**

* Constructs a new <code>UpdateSmtpTemplateSender</code>.
* Sender details including email and/or name. For example {&#39;name&#39;:&#39;xyz&#39; , &#39;email&#39;:&#39;example@abc.com&#39;}
* Sender details including email and/or name. For example &#x60;{\&quot;name\&quot;:\&quot;xyz\&quot;, \&quot;email\&quot;:\&quot;example@abc.com\&quot;}&#x60;
* @alias module:model/UpdateSmtpTemplateSender

@@ -48,0 +48,0 @@ * @class

@@ -174,4 +174,40 @@ /**

it('should have the property abTesting (base name: "abTesting")', function() {
// uncomment below and update the code to test the property abTesting
//var instane = new SibApiV3Sdk.CreateEmailCampaign();
//expect(instance).to.be();
});
it('should have the property subjectA (base name: "subjectA")', function() {
// uncomment below and update the code to test the property subjectA
//var instane = new SibApiV3Sdk.CreateEmailCampaign();
//expect(instance).to.be();
});
it('should have the property subjectB (base name: "subjectB")', function() {
// uncomment below and update the code to test the property subjectB
//var instane = new SibApiV3Sdk.CreateEmailCampaign();
//expect(instance).to.be();
});
it('should have the property splitRule (base name: "splitRule")', function() {
// uncomment below and update the code to test the property splitRule
//var instane = new SibApiV3Sdk.CreateEmailCampaign();
//expect(instance).to.be();
});
it('should have the property winnerCriteria (base name: "winnerCriteria")', function() {
// uncomment below and update the code to test the property winnerCriteria
//var instane = new SibApiV3Sdk.CreateEmailCampaign();
//expect(instance).to.be();
});
it('should have the property winnerDelay (base name: "winnerDelay")', function() {
// uncomment below and update the code to test the property winnerDelay
//var instane = new SibApiV3Sdk.CreateEmailCampaign();
//expect(instance).to.be();
});
});
}));

@@ -96,4 +96,46 @@ /**

it('should have the property abTesting (base name: "abTesting")', function() {
// uncomment below and update the code to test the property abTesting
//var instane = new SibApiV3Sdk.GetCampaignOverview();
//expect(instance).to.be();
});
it('should have the property subjectA (base name: "subjectA")', function() {
// uncomment below and update the code to test the property subjectA
//var instane = new SibApiV3Sdk.GetCampaignOverview();
//expect(instance).to.be();
});
it('should have the property subjectB (base name: "subjectB")', function() {
// uncomment below and update the code to test the property subjectB
//var instane = new SibApiV3Sdk.GetCampaignOverview();
//expect(instance).to.be();
});
it('should have the property splitRule (base name: "splitRule")', function() {
// uncomment below and update the code to test the property splitRule
//var instane = new SibApiV3Sdk.GetCampaignOverview();
//expect(instance).to.be();
});
it('should have the property winnerCriteria (base name: "winnerCriteria")', function() {
// uncomment below and update the code to test the property winnerCriteria
//var instane = new SibApiV3Sdk.GetCampaignOverview();
//expect(instance).to.be();
});
it('should have the property winnerDelay (base name: "winnerDelay")', function() {
// uncomment below and update the code to test the property winnerDelay
//var instane = new SibApiV3Sdk.GetCampaignOverview();
//expect(instance).to.be();
});
it('should have the property sendAtBestTime (base name: "sendAtBestTime")', function() {
// uncomment below and update the code to test the property sendAtBestTime
//var instane = new SibApiV3Sdk.GetCampaignOverview();
//expect(instance).to.be();
});
});
}));

@@ -174,4 +174,40 @@ /**

it('should have the property abTesting (base name: "abTesting")', function() {
// uncomment below and update the code to test the property abTesting
//var instane = new SibApiV3Sdk.UpdateEmailCampaign();
//expect(instance).to.be();
});
it('should have the property subjectA (base name: "subjectA")', function() {
// uncomment below and update the code to test the property subjectA
//var instane = new SibApiV3Sdk.UpdateEmailCampaign();
//expect(instance).to.be();
});
it('should have the property subjectB (base name: "subjectB")', function() {
// uncomment below and update the code to test the property subjectB
//var instane = new SibApiV3Sdk.UpdateEmailCampaign();
//expect(instance).to.be();
});
it('should have the property splitRule (base name: "splitRule")', function() {
// uncomment below and update the code to test the property splitRule
//var instane = new SibApiV3Sdk.UpdateEmailCampaign();
//expect(instance).to.be();
});
it('should have the property winnerCriteria (base name: "winnerCriteria")', function() {
// uncomment below and update the code to test the property winnerCriteria
//var instane = new SibApiV3Sdk.UpdateEmailCampaign();
//expect(instance).to.be();
});
it('should have the property winnerDelay (base name: "winnerDelay")', function() {
// uncomment below and update the code to test the property winnerDelay
//var instane = new SibApiV3Sdk.UpdateEmailCampaign();
//expect(instance).to.be();
});
});
}));
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc