Skip to content

Commit 3553792

Browse files
Amit JoshiAmit Joshi
Amit Joshi
authored and
Amit Joshi
committed
Updated docs
1 parent 9a8e022 commit 3553792

13 files changed

+25
-26
lines changed

‎docs/CreateAttribute.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**value** | **String** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional]
8-
**enumeration** | [**List<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+
**enumeration** | [**List<CreateAttributeEnumeration>**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attributes category is "category'. For example, [{"value":1, "label":"male"}, {"value":2, "label":"female"}] | [optional]
99
**type** | [**TypeEnum**](#TypeEnum) | 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]
1010

1111

‎docs/CreateContact.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**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]
8-
**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]
7+
**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]
8+
**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]
99
**emailBlacklisted** | **Boolean** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional]
1010
**smsBlacklisted** | **Boolean** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional]
1111
**listIds** | **List<Long>** | Ids of the lists to add the contact to | [optional]

‎docs/GetAccountPlan.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**type** | [**TypeEnum**](#TypeEnum) | Displays the plan type of the user |
8-
**creditsType** | [**CreditsTypeEnum**](#CreditsTypeEnum) | 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. |
8+
**creditsType** | [**CreditsTypeEnum**](#CreditsTypeEnum) | 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. |
99
**credits** | **Float** | Remaining credits of the user |
10-
**startDate** | **LocalDate** | Date of the period from which the plan will start (only available for \"subscription\" and \"reseller\" plan type) | [optional]
11-
**endDate** | **LocalDate** | Date of the period from which the plan will end (only available for \"subscription\" and \"reseller\" plan type) | [optional]
10+
**startDate** | **LocalDate** | Date of the period from which the plan will start (only available for 'subscription' and 'reseller' plan type) | [optional]
11+
**endDate** | **LocalDate** | Date of the period from which the plan will end (only available for 'subscription' and 'reseller' plan type) | [optional]
1212
**userLimit** | **Integer** | Only in case of reseller account. It implies the total number of child accounts you can add to your account. | [optional]
1313

1414

‎docs/GetAttributesAttributes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
**name** | **String** | Name of the attribute |
88
**category** | [**CategoryEnum**](#CategoryEnum) | Category of the attribute |
99
**type** | [**TypeEnum**](#TypeEnum) | Type of the attribute | [optional]
10-
**enumeration** | [**List<GetAttributesEnumeration>**](GetAttributesEnumeration.md) | Parameter only available for \"category\" type attributes. | [optional]
10+
**enumeration** | [**List<GetAttributesEnumeration>**](GetAttributesEnumeration.md) | Parameter only available for 'category' type attributes. | [optional]
1111
**calculatedValue** | **String** | Calculated value formula | [optional]
1212

1313

‎docs/GetAttributesEnumeration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**value** | **Long** | ID of Value of the \"category\" type attribute |
8-
**label** | **String** | Label of the \"category\" type attribute |
7+
**value** | **Long** | ID of Value of the 'category' type attribute |
8+
**label** | **String** | Label of the 'category' type attribute |
99

1010

1111

‎docs/GetExtendedCampaignOverview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ Name | Type | Description | Notes
2121
**header** | **String** | Header of the campaign |
2222
**footer** | **String** | Footer of the campaign |
2323
**sender** | [**GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) | |
24-
**replyTo** | **String** | Email defined as the \"Reply to\" of the campaign |
25-
**toField** | **String** | Customisation of the \"to\" field of the campaign |
24+
**replyTo** | **String** | Email defined as the 'Reply to' of the campaign |
25+
**toField** | **String** | Customisation of the 'to' field of the campaign |
2626
**htmlContent** | **String** | HTML content of the campaign |
2727
**shareLink** | **String** | Link to share the campaign on social medias | [optional]
2828
**tag** | **String** | Tag of the campaign |

‎docs/GetSmtpTemplateOverview.md

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

‎docs/RequestContactExport.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**exportAttributes** | **List<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]
8-
**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+
**exportAttributes** | **List<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]
8+
**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]
99
**customContactFilter** | [**RequestContactExportCustomContactFilter**](RequestContactExportCustomContactFilter.md) | | [optional]
1010
**notifyUrl** | **String** | Webhook that will be called once the export process is finished | [optional]
1111

‎docs/SendEmail.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**emailTo** | **List<String>** | List of the email addresses of the recipients. For example, ['[email protected]', '[email protected]']. |
7+
**emailTo** | **List<String>** | List of the email addresses of the recipients. For example, ["[email protected]", "[email protected]"]. |
88
**emailBcc** | **List<String>** | List of the email addresses of the recipients in bcc | [optional]
99
**emailCc** | **List<String>** | List of the email addresses of the recipients in cc | [optional]
1010
**replyTo** | **String** | Email address which shall be used by campaign recipients to reply back | [optional]
1111
**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]
12-
**attachment** | [**List<SendEmailAttachment>**](SendEmailAttachment.md) | Pass the list of content ( byte array which is encoded to base64 chunk data at our end ) and name of the attachment. For example, [{'content':'byte array content 1', 'name':'attcahment1'}, {'content':'byte array content 2', 'name':'attcahment2'}]. | [optional]
13-
**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]
14-
**attributes** | **Object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'} | [optional]
12+
**attachment** | [**List<SendEmailAttachment>**](SendEmailAttachment.md) | Pass the list of content ( byte array which is encoded to base64 chunk data at our end ) and name of the attachment. For example, [{"content":"byte array content 1", "name":"attcahment1"}, {"content":"byte array content 2", "name":"attcahment2"}]. | [optional]
13+
**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]
14+
**attributes** | **Object** | Pass the set of attributes to customize the template. For example, {"FNAME":"Joe", "LNAME":"Doe"} | [optional]
1515
**tags** | **List<String>** | Tag your emails to find them more easily | [optional]
1616

1717

‎docs/SendSmtpEmail.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**sender** | [**SendSmtpEmailSender**](SendSmtpEmailSender.md) | | [optional]
8-
**to** | [**List<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]'}] |
8+
**to** | [**List<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]"}] |
99
**bcc** | [**List<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional]
1010
**cc** | [**List<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional]
1111
**htmlContent** | **String** | HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) | [optional]
1212
**textContent** | **String** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional]
1313
**subject** | **String** | Subject of the message. Mandatory if 'templateId' is not passed | [optional]
1414
**replyTo** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
15-
**attachment** | [**List<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the byte array ( Encoded to base64 chunk data at our end ) 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':'byte array 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, 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]
16-
**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. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`. | [optional]
15+
**attachment** | [**List<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the byte array ( Encoded to base64 chunk data at our end ) 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.jpg"}, {"content":"byte array 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, 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]
16+
**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. For example, `{"sender.ip":"1.2.3.4", "X-Mailin-custom":"some_custom_header"}`. | [optional]
1717
**templateId** | **Long** | Id of the template | [optional]
18-
**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]
18+
**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]
1919
**tags** | **List<String>** | Tag your emails to find them more easily | [optional]
2020

2121

0 commit comments

Comments
 (0)