Skip to content

Commit b4d53d3

Browse files
shubhamUpadhyayInBlueshubhamUpadhyayInBlue
authored
Merge pull request #94 from sendinblue/feature_AP-1217
replace \" with double quote
2 parents 057935e + c15b48b commit b4d53d3

21 files changed

+32
-32
lines changed

‎docs/CreateAttribute.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**value** | **String** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional]
7-
**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]
7+
**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]
88
**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]
99

1010

‎docs/CreateContact.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**email** | **String** | Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. Mobile Number in \"SMS\" field should be passed with proper country code. For example {"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"} | [optional]
6+
**email** | **String** | Email address of the user. Mandatory if "SMS" field is not passed in "attributes" parameter. Mobile Number in "SMS" field should be passed with proper country code. For example {"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"} | [optional]
77
**attributes** | **Object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {"FIRSTNAME":"Elly", "LASTNAME":"Roger"} | [optional]
88
**emailBlacklisted** | **Boolean** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional]
99
**smsBlacklisted** | **Boolean** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional]

‎docs/CreateEmailCampaign.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
2020
**footer** | **String** | Footer of the email campaign | [optional]
2121
**header** | **String** | Header of the email campaign | [optional]
2222
**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]
23-
**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]
23+
**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]
2424
**sendAtBestTime** | **Boolean** | Set this to true if you want to send your campaign at best time. | [optional] [default to false]
2525
**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]
2626
**subjectA** | **String** | Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional]

‎docs/GetAccountPlan.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**type** | **String** | Displays the plan type of the user |
7-
**creditsType** | **String** | This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user. \"Send Limit\" implies the total number of emails you can send to the subscribers in your account. |
7+
**creditsType** | **String** | This is the type of the credit, "Send Limit" is one of the possible types of credit of a user. "Send Limit" implies the total number of emails you can send to the subscribers in your account. |
88
**credits** | **Number** | Remaining credits of the user |
9-
**startDate** | **Date** | Date of the period from which the plan will start (only available for \"subscription\" and \"reseller\" plan type) | [optional]
10-
**endDate** | **Date** | Date of the period from which the plan will end (only available for \"subscription\" and \"reseller\" plan type) | [optional]
9+
**startDate** | **Date** | Date of the period from which the plan will start (only available for "subscription" and "reseller" plan type) | [optional]
10+
**endDate** | **Date** | Date of the period from which the plan will end (only available for "subscription" and "reseller" plan type) | [optional]
1111
**userLimit** | **Number** | Only in case of reseller account. It implies the total number of child accounts you can add to your account. | [optional]
1212

1313

‎docs/GetAttributesAttributes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
66
**name** | **String** | Name of the attribute |
77
**category** | **String** | Category of the attribute |
88
**type** | **String** | Type of the attribute | [optional]
9-
**enumeration** | [**[GetAttributesEnumeration]**](GetAttributesEnumeration.md) | Parameter only available for \"category\" type attributes. | [optional]
9+
**enumeration** | [**[GetAttributesEnumeration]**](GetAttributesEnumeration.md) | Parameter only available for "category" type attributes. | [optional]
1010
**calculatedValue** | **String** | Calculated value formula | [optional]
1111

1212

‎docs/GetAttributesEnumeration.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**value** | **Number** | ID of Value of the \"category\" type attribute |
7-
**label** | **String** | Label of the \"category\" type attribute |
6+
**value** | **Number** | ID of Value of the "category" type attribute |
7+
**label** | **String** | Label of the "category" type attribute |
88

99

‎docs/GetExtendedCampaignOverview.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Name | Type | Description | Notes
77
**header** | **String** | Header of the campaign |
88
**footer** | **String** | Footer of the campaign |
99
**sender** | [**GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) | |
10-
**replyTo** | **String** | Email defined as the \"Reply to\" of the campaign |
11-
**toField** | **String** | Customisation of the \"to\" field of the campaign | [optional]
10+
**replyTo** | **String** | Email defined as the "Reply to" of the campaign |
11+
**toField** | **String** | Customisation of the "to" field of the campaign | [optional]
1212
**htmlContent** | **String** | HTML content of the campaign |
1313
**shareLink** | **String** | Link to share the campaign on social medias | [optional]
1414
**tag** | **String** | Tag of the campaign | [optional]

‎docs/GetSmtpTemplateOverview.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Name | Type | Description | Notes
99
**isActive** | **Boolean** | Status of template (true=active, false=inactive) |
1010
**testSent** | **Boolean** | Status of test sending for the template (true=test email has been sent, false=test email has not been sent) |
1111
**sender** | [**GetSmtpTemplateOverviewSender**](GetSmtpTemplateOverviewSender.md) | |
12-
**replyTo** | **String** | Email defined as the \"Reply to\" for the template |
13-
**toField** | **String** | Customisation of the \"to\" field for the template |
12+
**replyTo** | **String** | Email defined as the "Reply to" for the template |
13+
**toField** | **String** | Customisation of the "to" field for the template |
1414
**tag** | **String** | Tag of the template |
1515
**htmlContent** | **String** | HTML content of the template |
1616
**createdAt** | **Date** | Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |

‎docs/PostContactInfoContacts.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**success** | **[String]** | | [optional]
77
**failure** | **[String]** | | [optional]
8-
**total** | **Number** | Displays the count of total number of contacts removed from list when user opts for \"all\" option. | [optional]
9-
**processId** | **Number** | Id of the process created to remove contacts from list when user opts for \"all\" option. | [optional]
8+
**total** | **Number** | Displays the count of total number of contacts removed from list when user opts for "all" option. | [optional]
9+
**processId** | **Number** | Id of the process created to remove contacts from list when user opts for "all" option. | [optional]
1010

1111

‎docs/RequestContactExport.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**exportAttributes** | **[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-
**contactFilter** | **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+
**contactFilter** | **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]
88
**customContactFilter** | [**RequestContactExportCustomContactFilter**](RequestContactExportCustomContactFilter.md) | | [optional]
99
**notifyUrl** | **String** | Webhook that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional]
1010

‎docs/SendEmail.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Name | Type | Description | Notes
88
**emailCc** | **[String]** | List of the email addresses of the recipients in cc | [optional]
99
**replyTo** | **String** | Email address which shall be used by campaign recipients to reply back | [optional]
1010
**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]
11-
**attachment** | [**[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. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, {\"Content-Type\":\"text/html\", \"charset\":\"iso-8859-1\", \"sender.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]
11+
**attachment** | [**[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. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, {"Content-Type":"text/html", "charset":"iso-8859-1", "sender.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]
1414
**tags** | **[String]** | Tag your emails to find them more easily | [optional]
1515

1616

‎docs/SendSmtpEmail.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**sender** | [**SendSmtpEmailSender**](SendSmtpEmailSender.md) | | [optional]
7-
**to** | [**[SendSmtpEmailTo]**](SendSmtpEmailTo.md) | List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"[email protected]\"}, {\"name\":\"Joe\", \"email\":\"[email protected]\"}] |
7+
**to** | [**[SendSmtpEmailTo]**](SendSmtpEmailTo.md) | List of email addresses and names (optional) of the recipients. For example, [{"name":"Jimmy", "email":"[email protected]"}, {"name":"Joe", "email":"[email protected]"}] |
88
**bcc** | [**[SendSmtpEmailBcc]**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional]
99
**cc** | [**[SendSmtpEmailCc]**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional]
1010
**htmlContent** | **String** | HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) | [optional]
1111
**textContent** | **String** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional]
1212
**subject** | **String** | Subject of the message. Mandatory if 'templateId' is not passed | [optional]
1313
**replyTo** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
14-
**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, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional]
15-
**headers** | **Object** | Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`. | [optional]
14+
**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, `[{"url":"https://attachment.domain.com/myAttachmentFromUrl.jpg", "name":"myAttachmentFromUrl.jpg"}, {"content":"base64 example content", "name":"myAttachmentFromBase64.jpg"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional]
15+
**headers** | **Object** | Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{"sender.ip":"1.2.3.4", "X-Mailin-custom":"some_custom_header"}`. | [optional]
1616
**templateId** | **Number** | Id of the template | [optional]
17-
**params** | **Object** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. | [optional]
17+
**params** | **Object** | Pass the set of attributes to customize the template. For example, {"FNAME":"Joe", "LNAME":"Doe"}. It's considered only if template is in New Template Language format. | [optional]
1818
**tags** | **[String]** | Tag your emails to find them more easily | [optional]
1919

2020

0 commit comments

Comments
 (0)