Skip to content

Commit 6ff6a2f

Browse files
aakanksha-sibaakanksha-sib
committed
Swagger updates along with bug fixes and improvements
1 parent 0174150 commit 6ff6a2f

File tree

61 files changed

+269
-395
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+269
-395
lines changed

‎README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,6 @@ Class | Method | HTTP request | Description
243243
- [SibApiV3Sdk::GetEmailEventReportEvents](docs/GetEmailEventReportEvents.md)
244244
- [SibApiV3Sdk::GetExtendedCampaignOverviewSender](docs/GetExtendedCampaignOverviewSender.md)
245245
- [SibApiV3Sdk::GetExtendedCampaignStats](docs/GetExtendedCampaignStats.md)
246-
- [SibApiV3Sdk::GetExtendedCampaignStatsLinksStats](docs/GetExtendedCampaignStatsLinksStats.md)
247246
- [SibApiV3Sdk::GetExtendedClientAddress](docs/GetExtendedClientAddress.md)
248247
- [SibApiV3Sdk::GetExtendedContactDetailsStatistics](docs/GetExtendedContactDetailsStatistics.md)
249248
- [SibApiV3Sdk::GetExtendedContactDetailsStatisticsClicked](docs/GetExtendedContactDetailsStatisticsClicked.md)

‎docs/CreateAttribute.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**value** | **String** | Value of the attribute. Use only if the attribute's category is calculated or global | [optional]
7-
**enumeration** | [**Array<CreateAttributeEnumeration>**](CreateAttributeEnumeration.md) | Values that the attribute can take. Use only if the attribute's category is category | [optional]
8-
**type** | **String** | Type of the attribute. Use only if the attribute's category is normal, category or transactional ( type 'id' only available if the category is 'transactional' attribute & type 'category' only available if the category is 'category' attribute ) | [optional]
6+
**value** | **String** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional]
7+
**enumeration** | [**Array<CreateAttributeEnumeration>**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] | [optional]
8+
**type** | **String** | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [optional]
99

1010

‎docs/CreateContact.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**email** | **String** | Email address of the user. Mandatory if `attributes.sms` is not passed | [optional]
7-
**attributes** | **Object** | Values of the attributes to fill. The attributes must exist in you contact database | [optional]
8-
**email_blacklisted** | **BOOLEAN** | Blacklist the contact for emails (emailBlacklisted = true) | [optional]
9-
**sms_blacklisted** | **BOOLEAN** | Blacklist the contact for SMS (smsBlacklisted = true) | [optional]
6+
**email** | **String** | Email address of the user. Mandatory if \"sms\" field is not passed in \"attributes\" parameter' | [optional]
7+
**attributes** | **Object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} | [optional]
8+
**email_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional]
9+
**sms_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional]
1010
**list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional]
11-
**update_enabled** | **BOOLEAN** | Facilitate to update existing contact in same request (updateEnabled = true) | [optional] [default to false]
11+
**update_enabled** | **BOOLEAN** | Facilitate to update the existing contact in the same request (updateEnabled = true) | [optional] [default to false]
1212
**smtp_blacklist_sender** | **Array<String>** | SMTP forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | [optional]
1313

1414

‎docs/CreateList.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**name** | **String** | Name of the list |
7-
**folder_id** | **Integer** | Id of the folder in which to create the list |
7+
**folder_id** | **Integer** | Id of the parent folder in which this list is to be created |
88

99

‎docs/DeleteHardbounces.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**start_date** | **Date** | Starting date (YYYY-MM-DD) of the period from which the hardbounces will be deleted. Must be lower than equal to endDate | [optional]
7-
**end_date** | **Date** | Ending date (YYYY-MM-DD) of the period from which the hardbounces will be deleted. Must be greater than equal to startDate | [optional]
6+
**start_date** | **Date** | Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate | [optional]
7+
**end_date** | **Date** | Ending date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate | [optional]
88
**contact_email** | **String** | Target a specific email address | [optional]
99

1010

‎docs/GetCampaignStats.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**list_id** | **Integer** | List Id of email campaign (only in case of get email campaign(s)) | [optional]
6+
**list_id** | **Integer** | List Id of email campaign (only in case of get email campaign(s)(not for global stats)) | [optional]
77
**unique_clicks** | **Integer** | Number of unique clicks for the campaign |
8-
**clickers** | **Integer** | Number of clicks for the campaign |
8+
**clickers** | **Integer** | Number of total clicks for the campaign |
99
**complaints** | **Integer** | Number of complaints (Spam reports) for the campaign |
1010
**delivered** | **Integer** | Number of delivered emails for the campaign |
1111
**sent** | **Integer** | Number of sent emails for the campaign |
@@ -14,6 +14,6 @@ Name | Type | Description | Notes
1414
**unique_views** | **Integer** | Number of unique openings for the campaign |
1515
**unsubscriptions** | **Integer** | Number of unsubscription for the campaign |
1616
**viewed** | **Integer** | Number of openings for the campaign |
17-
**deferred** | **Integer** | Number of deferred emails for the campaign |
17+
**deferred** | **Integer** | Number of deferred emails for the campaign | [optional]
1818

1919

‎docs/GetContactDetails.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ Name | Type | Description | Notes
1010
**modified_at** | **DateTime** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
1111
**list_ids** | **Array<Integer>** | |
1212
**list_unsubscribed** | **Array<Integer>** | | [optional]
13-
**attributes** | **Hash<String, String>** | |
13+
**attributes** | **Object** | Set of attributes of the contact |
1414

1515

‎docs/GetExtendedCampaignStats.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**campaign_stats** | **Array<Object>** | |
6+
**global_stats** | **Object** | Overall statistics of the campaign |
7+
**campaign_stats** | **Array<Object>** | List-wise statistics of the campaign. |
78
**mirror_click** | **Integer** | Number of clicks on mirror link |
89
**remaining** | **Integer** | Number of remaning emails to send |
9-
**links_stats** | [**Hash<String, GetExtendedCampaignStatsLinksStats>**](GetExtendedCampaignStatsLinksStats.md) | |
10+
**links_stats** | **Object** | Statistics about the number of clicks for the links |
1011
**stats_by_domain** | [**GetStatsByDomain**](GetStatsByDomain.md) | |
1112

1213

‎docs/GetExtendedCampaignStatsLinksStats.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎docs/GetExtendedContactDetails.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
1010
**modified_at** | **DateTime** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
1111
**list_ids** | **Array<Integer>** | |
1212
**list_unsubscribed** | **Array<Integer>** | | [optional]
13-
**attributes** | **Hash<String, String>** | |
13+
**attributes** | **Object** | Set of attributes of the contact |
1414
**statistics** | [**GetExtendedContactDetailsStatistics**](GetExtendedContactDetailsStatistics.md) | |
1515

1616

0 commit comments

Comments
 (0)