Skip to content

Commit 94a4a44

Browse files
Aakanksha SharmaAakanksha Sharma
Aakanksha Sharma
authored and
Aakanksha Sharma
committed
specification based changes synced with latest swagger updates
1 parent befaedb commit 94a4a44

File tree

61 files changed

+1299
-486
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

+1299
-486
lines changed

‎README.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -54,20 +54,20 @@ Please follow the [installation](#installation) procedure and then run the follo
5454
require 'sib-api-v3-sdk'
5555

5656
# Setup authorization
57-
SendinblueApiv3.configure do |config|
57+
SibApiV3Sdk.configure do |config|
5858
# Configure API key authorization: api-key
5959
config.api_key['api-key'] = 'YOUR API KEY'
6060
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
6161
#config.api_key_prefix['api-key'] = 'Bearer'
6262
end
6363

64-
api_instance = SendinblueApiv3::AccountApi.new
64+
api_instance = SibApiV3Sdk::AccountApi.new
6565

6666
begin
6767
#Get your account informations, plans and credits details
6868
result = api_instance.get_account
6969
p result
70-
rescue SendinblueApiv3::ApiError => e
70+
rescue SibApiV3Sdk::ApiError => e
7171
puts "Exception when calling AccountApi->get_account: #{e}"
7272
end
7373

@@ -229,13 +229,9 @@ Class | Method | HTTP request | Description
229229
- [SibApiV3Sdk::GetClient](docs/GetClient.md)
230230
- [SibApiV3Sdk::GetContactCampaignStats](docs/GetContactCampaignStats.md)
231231
- [SibApiV3Sdk::GetContactCampaignStatsClicked](docs/GetContactCampaignStatsClicked.md)
232-
- [SibApiV3Sdk::GetContactCampaignStatsLinks](docs/GetContactCampaignStatsLinks.md)
233-
- [SibApiV3Sdk::GetContactCampaignStatsMessagesSent](docs/GetContactCampaignStatsMessagesSent.md)
234232
- [SibApiV3Sdk::GetContactCampaignStatsOpened](docs/GetContactCampaignStatsOpened.md)
235233
- [SibApiV3Sdk::GetContactCampaignStatsTransacAttributes](docs/GetContactCampaignStatsTransacAttributes.md)
236234
- [SibApiV3Sdk::GetContactCampaignStatsUnsubscriptions](docs/GetContactCampaignStatsUnsubscriptions.md)
237-
- [SibApiV3Sdk::GetContactCampaignStatsUnsubscriptionsAdminUnsubscription](docs/GetContactCampaignStatsUnsubscriptionsAdminUnsubscription.md)
238-
- [SibApiV3Sdk::GetContactCampaignStatsUnsubscriptionsUserUnsubscription](docs/GetContactCampaignStatsUnsubscriptionsUserUnsubscription.md)
239235
- [SibApiV3Sdk::GetContactDetails](docs/GetContactDetails.md)
240236
- [SibApiV3Sdk::GetContacts](docs/GetContacts.md)
241237
- [SibApiV3Sdk::GetEmailCampaigns](docs/GetEmailCampaigns.md)
@@ -245,6 +241,14 @@ Class | Method | HTTP request | Description
245241
- [SibApiV3Sdk::GetExtendedCampaignStats](docs/GetExtendedCampaignStats.md)
246242
- [SibApiV3Sdk::GetExtendedCampaignStatsLinksStats](docs/GetExtendedCampaignStatsLinksStats.md)
247243
- [SibApiV3Sdk::GetExtendedClientAddress](docs/GetExtendedClientAddress.md)
244+
- [SibApiV3Sdk::GetExtendedContactDetailsStatistics](docs/GetExtendedContactDetailsStatistics.md)
245+
- [SibApiV3Sdk::GetExtendedContactDetailsStatisticsClicked](docs/GetExtendedContactDetailsStatisticsClicked.md)
246+
- [SibApiV3Sdk::GetExtendedContactDetailsStatisticsLinks](docs/GetExtendedContactDetailsStatisticsLinks.md)
247+
- [SibApiV3Sdk::GetExtendedContactDetailsStatisticsMessagesSent](docs/GetExtendedContactDetailsStatisticsMessagesSent.md)
248+
- [SibApiV3Sdk::GetExtendedContactDetailsStatisticsOpened](docs/GetExtendedContactDetailsStatisticsOpened.md)
249+
- [SibApiV3Sdk::GetExtendedContactDetailsStatisticsUnsubscriptions](docs/GetExtendedContactDetailsStatisticsUnsubscriptions.md)
250+
- [SibApiV3Sdk::GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription](docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md)
251+
- [SibApiV3Sdk::GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription](docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md)
248252
- [SibApiV3Sdk::GetExtendedListCampaignStats](docs/GetExtendedListCampaignStats.md)
249253
- [SibApiV3Sdk::GetFolder](docs/GetFolder.md)
250254
- [SibApiV3Sdk::GetFolderLists](docs/GetFolderLists.md)
@@ -255,8 +259,6 @@ Class | Method | HTTP request | Description
255259
- [SibApiV3Sdk::GetIpsFromSender](docs/GetIpsFromSender.md)
256260
- [SibApiV3Sdk::GetList](docs/GetList.md)
257261
- [SibApiV3Sdk::GetLists](docs/GetLists.md)
258-
- [SibApiV3Sdk::GetListsFolder](docs/GetListsFolder.md)
259-
- [SibApiV3Sdk::GetListsLists](docs/GetListsLists.md)
260262
- [SibApiV3Sdk::GetProcess](docs/GetProcess.md)
261263
- [SibApiV3Sdk::GetProcesses](docs/GetProcesses.md)
262264
- [SibApiV3Sdk::GetReports](docs/GetReports.md)

‎docs/GetAccountPlan.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**type** | **String** | Displays the plan type of the user |
77
**credits_type** | **String** | This is the type of the credit, \"User Limit\" or \"Send Limit\" are two possible types of credit of a user. \"User Limit\" implies the total number of subscribers you can add to your account, and \"Send Limit\" implies the total number of emails you can send to the subscribers in your account. |
8-
**credits** | **Integer** | Remaining credits of the user. This can either be \"User Limit\" or \"Send Limit\" depending on the plan. |
8+
**credits** | **Float** | Remaining credits of the user. This can either be \"User Limit\" or \"Send Limit\" depending on the plan. |
99

1010

‎docs/GetCampaignStats.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
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)) |
6+
**list_id** | **Integer** | List Id of email campaign (only in case of get email campaign(s)) | [optional]
77
**unique_clicks** | **Integer** | Number of unique clicks for the campaign |
88
**clickers** | **Integer** | Number of clicks for the campaign |
99
**complaints** | **Integer** | Number of complaints (Spam reports) for the campaign |

‎docs/GetContactCampaignStats.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**messages_sent** | [**Array<GetContactCampaignStatsMessagesSent>**](GetContactCampaignStatsMessagesSent.md) | | [optional]
7-
**hard_bounces** | [**Array<GetContactCampaignStatsMessagesSent>**](GetContactCampaignStatsMessagesSent.md) | | [optional]
8-
**soft_bounces** | [**Array<GetContactCampaignStatsMessagesSent>**](GetContactCampaignStatsMessagesSent.md) | | [optional]
9-
**complaints** | [**Array<GetContactCampaignStatsMessagesSent>**](GetContactCampaignStatsMessagesSent.md) | | [optional]
6+
**messages_sent** | [**Array<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional]
7+
**hard_bounces** | [**Array<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional]
8+
**soft_bounces** | [**Array<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional]
9+
**complaints** | [**Array<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional]
1010
**unsubscriptions** | [**GetContactCampaignStatsUnsubscriptions**](GetContactCampaignStatsUnsubscriptions.md) | | [optional]
1111
**opened** | [**Array<GetContactCampaignStatsOpened>**](GetContactCampaignStatsOpened.md) | | [optional]
1212
**clicked** | [**Array<GetContactCampaignStatsClicked>**](GetContactCampaignStatsClicked.md) | | [optional]

‎docs/GetContactCampaignStatsClicked.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**campaign_id** | **Integer** | ID of the campaign which generated the event |
7-
**links** | [**Array<GetContactCampaignStatsLinks>**](GetContactCampaignStatsLinks.md) | |
7+
**links** | [**Array<GetExtendedContactDetailsStatisticsLinks>**](GetExtendedContactDetailsStatisticsLinks.md) | |
88

99

‎docs/GetContactCampaignStatsOpened.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**campaign_id** | **Integer** | ID of the campaign which generated the event |
77
**count** | **Integer** | Number of openings of the campaign |
8-
**event_time** | **DateTime** | Date of the event |
8+
**event_time** | **String** | Date of the event |
99
**ip** | **String** | IP from which the user has opened the campaign |
1010

1111

‎docs/GetContactCampaignStatsUnsubscriptions.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**user_unsubscription** | [**Array<GetContactCampaignStatsUnsubscriptionsUserUnsubscription>**](GetContactCampaignStatsUnsubscriptionsUserUnsubscription.md) | Contact has unsubscribed via the unsubscription link in the email |
7-
**admin_unsubscription** | [**Array<GetContactCampaignStatsUnsubscriptionsAdminUnsubscription>**](GetContactCampaignStatsUnsubscriptionsAdminUnsubscription.md) | Contact has been unsubscribed from the administrator |
6+
**user_unsubscription** | [**Array<GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription>**](GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md) | Contact has unsubscribed via the unsubscription link in the email |
7+
**admin_unsubscription** | [**Array<GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription>**](GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md) | Contact has been unsubscribed from the administrator |
88

99

‎docs/GetEmailCampaign.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
1616
**reply_to** | **String** | Email defined as the \"Reply to\" of the campaign |
1717
**to_field** | **String** | Customisation of the \"to\" field of the campaign |
1818
**html_content** | **String** | HTML content of the campaign |
19-
**share_link** | **String** | Link to share the campaign on social medias |
19+
**share_link** | **String** | Link to share the campaign on social medias | [optional]
2020
**tag** | **String** | Tag of the campaign |
2121
**created_at** | **String** | Creation date of the campaign (YYYY-MM-DD HH:mm:ss) |
2222
**modified_at** | **String** | Date of last modification of the campaign (YYYY-MM-DD HH:mm:ss) |

‎docs/GetEmailEventReportEvents.md

+2
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,12 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**email** | **String** | Email address which generates the event |
77
**date** | **Date** | Date on which the event has been generated |
8+
**subject** | **String** | Subject of the event | [optional]
89
**message_id** | **String** | Message ID which generated the event |
910
**event** | **String** | Event which occured |
1011
**reason** | **String** | Reason of bounce (only availble if the event is hardbounce or softbounce) |
1112
**tag** | **String** | Tag of the email which generated the event |
1213
**ip** | **String** | IP from which the user has opened the email or clicked on the link (only availble if the event is opened or clicks) | [optional]
14+
**link** | **String** | The link which is sent to the user (only availble if the event is requests or opened or clicks) | [optional]
1315

1416

‎docs/GetExtendedCampaignOverview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
1616
**reply_to** | **String** | Email defined as the \"Reply to\" of the campaign |
1717
**to_field** | **String** | Customisation of the \"to\" field of the campaign |
1818
**html_content** | **String** | HTML content of the campaign |
19-
**share_link** | **String** | Link to share the campaign on social medias |
19+
**share_link** | **String** | Link to share the campaign on social medias | [optional]
2020
**tag** | **String** | Tag of the campaign |
2121
**created_at** | **String** | Creation date of the campaign (YYYY-MM-DD HH:mm:ss) |
2222
**modified_at** | **String** | Date of last modification of the campaign (YYYY-MM-DD HH:mm:ss) |

‎docs/GetExtendedContactDetails.md

+1
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,6 @@ Name | Type | Description | Notes
1111
**list_ids** | **Array<Integer>** | |
1212
**list_unsubscribed** | **Array<Integer>** | | [optional]
1313
**attributes** | **Hash<String, String>** | |
14+
**statistics** | [**GetExtendedContactDetailsStatistics**](GetExtendedContactDetailsStatistics.md) | | [optional]
1415

1516

‎docs/GetExtendedContactDetailsStatistics.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# SibApiV3Sdk::GetExtendedContactDetailsStatistics
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**messages_sent** | [**Array<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | Listing of the sent campaign for the contact | [optional]
7+
**hard_bounces** | [**Array<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | Listing of the hardbounes generated by the contact | [optional]
8+
**soft_bounces** | [**Array<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | Listing of the softbounes generated by the contact | [optional]
9+
**complaints** | [**Array<GetExtendedContactDetailsStatisticsMessagesSent>**](GetExtendedContactDetailsStatisticsMessagesSent.md) | Listing of the complaints generated by the contact | [optional]
10+
**unsubscriptions** | [**GetExtendedContactDetailsStatisticsUnsubscriptions**](GetExtendedContactDetailsStatisticsUnsubscriptions.md) | | [optional]
11+
**opened** | [**Array<GetExtendedContactDetailsStatisticsOpened>**](GetExtendedContactDetailsStatisticsOpened.md) | Listing of the openings generated by the contact | [optional]
12+
**clicked** | [**Array<GetExtendedContactDetailsStatisticsClicked>**](GetExtendedContactDetailsStatisticsClicked.md) | Listing of the clicks generated by the contact | [optional]
13+
**transac_attributes** | **Array<Object>** | Listing of the transactional attributes for the contact | [optional]
14+
15+

‎docs/GetExtendedContactDetailsStatisticsClicked.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# SibApiV3Sdk::GetExtendedContactDetailsStatisticsClicked
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**campaign_id** | **Integer** | ID of the campaign which generated the event |
7+
**links** | [**Array<GetExtendedContactDetailsStatisticsLinks>**](GetExtendedContactDetailsStatisticsLinks.md) | Listing of the clicked links for the campaign |
8+
9+

‎docs/GetContactCampaignStatsLinks.md renamed to ‎docs/GetExtendedContactDetailsStatisticsLinks.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# SibApiV3Sdk::GetContactCampaignStatsLinks
1+
# SibApiV3Sdk::GetExtendedContactDetailsStatisticsLinks
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**count** | **Integer** | Number of clicks on this link for the campaign |
7-
**event_time** | **DateTime** | Date of the event |
7+
**event_time** | **String** | Date of the event |
88
**ip** | **String** | IP from which the user has clicked on the link |
99
**url** | **String** | URL of the clicked link |
1010

‎docs/GetContactCampaignStatsMessagesSent.md renamed to ‎docs/GetExtendedContactDetailsStatisticsMessagesSent.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# SibApiV3Sdk::GetContactCampaignStatsMessagesSent
1+
# SibApiV3Sdk::GetExtendedContactDetailsStatisticsMessagesSent
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**campaign_id** | **Integer** | ID of the campaign which generated the event |
7-
**event_time** | **DateTime** | Date of the event |
7+
**event_time** | **String** | Date of the event |
88

99

‎docs/GetExtendedContactDetailsStatisticsOpened.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# SibApiV3Sdk::GetExtendedContactDetailsStatisticsOpened
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**campaign_id** | **Integer** | ID of the campaign which generated the event |
7+
**count** | **Integer** | Number of openings for the campaign |
8+
**event_time** | **String** | Date of the event |
9+
**ip** | **String** | IP from which the user has opened the email |
10+
11+

‎docs/GetExtendedContactDetailsStatisticsUnsubscriptions.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# SibApiV3Sdk::GetExtendedContactDetailsStatisticsUnsubscriptions
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**user_unsubscription** | [**Array<GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription>**](GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md) | Contact unsubscribe via unsubscription link in a campaign |
7+
**admin_unsubscription** | [**Array<GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription>**](GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md) | Contact has been unsubscribed from the administrator |
8+
9+

‎docs/GetContactCampaignStatsUnsubscriptionsAdminUnsubscription.md renamed to ‎docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# SibApiV3Sdk::GetContactCampaignStatsUnsubscriptionsAdminUnsubscription
1+
# SibApiV3Sdk::GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**event_time** | **DateTime** | Date of the event |
6+
**event_time** | **String** | Date of the event |
77
**ip** | **String** | IP from which the user has been unsubscribed |
88

99

‎docs/GetContactCampaignStatsUnsubscriptionsUserUnsubscription.md renamed to ‎docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# SibApiV3Sdk::GetContactCampaignStatsUnsubscriptionsUserUnsubscription
1+
# SibApiV3Sdk::GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**campaign_id** | **Integer** | ID of the campaign which generated the event |
7-
**event_time** | **DateTime** | Date of the event |
7+
**event_time** | **String** | Date of the event |
88
**ip** | **String** | IP from which the user has unsubscribed |
99

1010

‎docs/GetExtendedList.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**total_blacklisted** | **Integer** | Number of blacklisted contacts in the list |
99
**total_subscribers** | **Integer** | Number of contacts in the list |
1010
**folder_id** | **Integer** | ID of the folder |
11-
**created_at** | **String** | Creation Date of the list (YYYY-MM-DD) |
11+
**created_at** | **String** | Creation Date of the list (YYYY-MM-DD HH:mm:ss) |
1212
**campaign_stats** | [**Array<GetExtendedListCampaignStats>**](GetExtendedListCampaignStats.md) | | [optional]
1313
**dynamic_list** | **BOOLEAN** | Status telling if the list is dynamic or not (true=dynamic, false=not dynamic) | [optional]
1414

‎docs/GetLists.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6+
**lists** | **Array<Object>** | Listing of all the lists available in your account |
67
**count** | **Integer** | Number of lists in your account |
7-
**lists** | [**Array<GetListsLists>**](GetListsLists.md) | Listing of all the lists available in your account |
88

99

‎docs/GetListsFolder.md

-9
This file was deleted.

‎docs/GetListsLists.md

-8
This file was deleted.

‎docs/GetWebhook.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**description** | **String** | Description of the webhook |
99
**events** | **Array<String>** | |
1010
**type** | **String** | Type of webhook (marketing or transac) |
11-
**created_at** | **String** | Creation date of the webhook (YYYY-MM-DD) |
12-
**modified_at** | **String** | Last modification date of the webhook (YYYY-MM-DD) |
11+
**created_at** | **String** | Creation date of the webhook (YYYY-MM-DD HH:mm:ss) |
12+
**modified_at** | **String** | Last modification date of the webhook (YYYY-MM-DD HH:mm:ss) |
1313

1414

0 commit comments

Comments
 (0)