sib-api-v3-sdk 2.0.0 → 2.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +11 -9
- data/docs/GetAccountPlan.md +1 -1
- data/docs/GetCampaignStats.md +1 -1
- data/docs/GetContactCampaignStats.md +4 -4
- data/docs/GetContactCampaignStatsClicked.md +1 -1
- data/docs/GetContactCampaignStatsOpened.md +1 -1
- data/docs/GetContactCampaignStatsUnsubscriptions.md +2 -2
- data/docs/GetEmailCampaign.md +1 -1
- data/docs/GetEmailEventReportEvents.md +2 -0
- data/docs/GetExtendedCampaignOverview.md +1 -1
- data/docs/GetExtendedContactDetails.md +1 -0
- data/docs/GetExtendedContactDetailsStatistics.md +15 -0
- data/docs/GetExtendedContactDetailsStatisticsClicked.md +9 -0
- data/docs/{GetContactCampaignStatsLinks.md → GetExtendedContactDetailsStatisticsLinks.md} +2 -2
- data/docs/{GetContactCampaignStatsMessagesSent.md → GetExtendedContactDetailsStatisticsMessagesSent.md} +2 -2
- data/docs/GetExtendedContactDetailsStatisticsOpened.md +11 -0
- data/docs/GetExtendedContactDetailsStatisticsUnsubscriptions.md +9 -0
- data/docs/{GetContactCampaignStatsUnsubscriptionsAdminUnsubscription.md → GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md} +2 -2
- data/docs/{GetContactCampaignStatsUnsubscriptionsUserUnsubscription.md → GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md} +2 -2
- data/docs/GetExtendedList.md +1 -1
- data/docs/GetLists.md +1 -1
- data/docs/GetWebhook.md +2 -2
- data/lib/sib-api-v3-sdk.rb +8 -6
- data/lib/sib-api-v3-sdk/models/get_account_plan.rb +1 -1
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +0 -5
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats.rb +4 -4
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_clicked.rb +1 -1
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +20 -1
- data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +0 -5
- data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +24 -4
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +0 -5
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +13 -4
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb +272 -0
- data/lib/sib-api-v3-sdk/models/{get_contact_campaign_stats_messages_sent.rb → get_extended_contact_details_statistics_clicked.rb} +14 -12
- data/lib/sib-api-v3-sdk/models/{get_contact_campaign_stats_links.rb → get_extended_contact_details_statistics_links.rb} +21 -2
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +228 -0
- data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +258 -0
- data/lib/sib-api-v3-sdk/models/{get_lists_folder.rb → get_extended_contact_details_statistics_unsubscriptions.rb} +27 -23
- data/lib/sib-api-v3-sdk/models/{get_contact_campaign_stats_unsubscriptions_admin_unsubscription.rb → get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb} +21 -2
- data/lib/sib-api-v3-sdk/models/{get_contact_campaign_stats_unsubscriptions_user_unsubscription.rb → get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb} +21 -2
- data/lib/sib-api-v3-sdk/models/get_extended_list.rb +6 -6
- data/lib/sib-api-v3-sdk/models/get_lists.rb +19 -19
- data/lib/sib-api-v3-sdk/models/get_webhook.rb +12 -12
- data/lib/sib-api-v3-sdk/version.rb +1 -1
- data/spec/models/get_email_event_report_events_spec.rb +12 -0
- data/spec/models/get_extended_contact_details_spec.rb +6 -0
- data/spec/models/{get_lists_folder_spec.rb → get_extended_contact_details_statistics_clicked_spec.rb} +8 -8
- data/spec/models/{get_contact_campaign_stats_links_spec.rb → get_extended_contact_details_statistics_links_spec.rb} +6 -6
- data/spec/models/{get_contact_campaign_stats_messages_sent_spec.rb → get_extended_contact_details_statistics_messages_sent_spec.rb} +6 -6
- data/spec/models/get_extended_contact_details_statistics_opened_spec.rb +60 -0
- data/spec/models/get_extended_contact_details_statistics_spec.rb +84 -0
- data/spec/models/{get_contact_campaign_stats_unsubscriptions_admin_unsubscription_spec.rb → get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription_spec.rb} +6 -6
- data/spec/models/get_extended_contact_details_statistics_unsubscriptions_spec.rb +48 -0
- data/spec/models/{get_contact_campaign_stats_unsubscriptions_user_unsubscription_spec.rb → get_extended_contact_details_statistics_unsubscriptions_user_unsubscription_spec.rb} +6 -6
- data/spec/models/get_lists_spec.rb +2 -2
- metadata +34 -27
- data/docs/GetListsFolder.md +0 -9
- data/docs/GetListsLists.md +0 -8
- data/git_push.sh +0 -55
- data/lib/sib-api-v3-sdk/models/get_lists_lists.rb +0 -188
- data/spec/models/get_lists_lists_spec.rb +0 -42
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ff2b749eee2a0089ea9bece7a9bcea3c1d5dd739
|
4
|
+
data.tar.gz: fb9e32f8150278ed7424089b484988bb3c6ac118
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8956d3518d78072bb7a75f8c2840dc968bf8c9b8ce0d30eeb7a3d5b4f223d04a1e1f74e540570f4190bd7ee530be8a75c402ed3d698675df954b799422d2653b
|
7
|
+
data.tar.gz: d9a30322bab8063315119e3530b9bac38a31ec68f34181249eefe0087b7331d974c85f081112266193bdbd3a64a4c23388a3a9d407f805d4335c23ed9953243b
|
data/README.md
CHANGED
@@ -54,20 +54,20 @@ Please follow the [installation](#installation) procedure and then run the follo
|
|
54
54
|
require 'sib-api-v3-sdk'
|
55
55
|
|
56
56
|
# Setup authorization
|
57
|
-
|
57
|
+
SibApiV3Sdk.configure do |config|
|
58
58
|
# Configure API key authorization: api-key
|
59
59
|
config.api_key['api-key'] = 'YOUR API KEY'
|
60
60
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
61
61
|
#config.api_key_prefix['api-key'] = 'Bearer'
|
62
62
|
end
|
63
63
|
|
64
|
-
api_instance =
|
64
|
+
api_instance = SibApiV3Sdk::AccountApi.new
|
65
65
|
|
66
66
|
begin
|
67
67
|
#Get your account informations, plans and credits details
|
68
68
|
result = api_instance.get_account
|
69
69
|
p result
|
70
|
-
rescue
|
70
|
+
rescue SibApiV3Sdk::ApiError => e
|
71
71
|
puts "Exception when calling AccountApi->get_account: #{e}"
|
72
72
|
end
|
73
73
|
|
@@ -229,13 +229,9 @@ Class | Method | HTTP request | Description
|
|
229
229
|
- [SibApiV3Sdk::GetClient](docs/GetClient.md)
|
230
230
|
- [SibApiV3Sdk::GetContactCampaignStats](docs/GetContactCampaignStats.md)
|
231
231
|
- [SibApiV3Sdk::GetContactCampaignStatsClicked](docs/GetContactCampaignStatsClicked.md)
|
232
|
-
- [SibApiV3Sdk::GetContactCampaignStatsLinks](docs/GetContactCampaignStatsLinks.md)
|
233
|
-
- [SibApiV3Sdk::GetContactCampaignStatsMessagesSent](docs/GetContactCampaignStatsMessagesSent.md)
|
234
232
|
- [SibApiV3Sdk::GetContactCampaignStatsOpened](docs/GetContactCampaignStatsOpened.md)
|
235
233
|
- [SibApiV3Sdk::GetContactCampaignStatsTransacAttributes](docs/GetContactCampaignStatsTransacAttributes.md)
|
236
234
|
- [SibApiV3Sdk::GetContactCampaignStatsUnsubscriptions](docs/GetContactCampaignStatsUnsubscriptions.md)
|
237
|
-
- [SibApiV3Sdk::GetContactCampaignStatsUnsubscriptionsAdminUnsubscription](docs/GetContactCampaignStatsUnsubscriptionsAdminUnsubscription.md)
|
238
|
-
- [SibApiV3Sdk::GetContactCampaignStatsUnsubscriptionsUserUnsubscription](docs/GetContactCampaignStatsUnsubscriptionsUserUnsubscription.md)
|
239
235
|
- [SibApiV3Sdk::GetContactDetails](docs/GetContactDetails.md)
|
240
236
|
- [SibApiV3Sdk::GetContacts](docs/GetContacts.md)
|
241
237
|
- [SibApiV3Sdk::GetEmailCampaigns](docs/GetEmailCampaigns.md)
|
@@ -245,6 +241,14 @@ Class | Method | HTTP request | Description
|
|
245
241
|
- [SibApiV3Sdk::GetExtendedCampaignStats](docs/GetExtendedCampaignStats.md)
|
246
242
|
- [SibApiV3Sdk::GetExtendedCampaignStatsLinksStats](docs/GetExtendedCampaignStatsLinksStats.md)
|
247
243
|
- [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)
|
248
252
|
- [SibApiV3Sdk::GetExtendedListCampaignStats](docs/GetExtendedListCampaignStats.md)
|
249
253
|
- [SibApiV3Sdk::GetFolder](docs/GetFolder.md)
|
250
254
|
- [SibApiV3Sdk::GetFolderLists](docs/GetFolderLists.md)
|
@@ -255,8 +259,6 @@ Class | Method | HTTP request | Description
|
|
255
259
|
- [SibApiV3Sdk::GetIpsFromSender](docs/GetIpsFromSender.md)
|
256
260
|
- [SibApiV3Sdk::GetList](docs/GetList.md)
|
257
261
|
- [SibApiV3Sdk::GetLists](docs/GetLists.md)
|
258
|
-
- [SibApiV3Sdk::GetListsFolder](docs/GetListsFolder.md)
|
259
|
-
- [SibApiV3Sdk::GetListsLists](docs/GetListsLists.md)
|
260
262
|
- [SibApiV3Sdk::GetProcess](docs/GetProcess.md)
|
261
263
|
- [SibApiV3Sdk::GetProcesses](docs/GetProcesses.md)
|
262
264
|
- [SibApiV3Sdk::GetReports](docs/GetReports.md)
|
data/docs/GetAccountPlan.md
CHANGED
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**type** | **String** | Displays the plan type of the user |
|
7
7
|
**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** | **
|
8
|
+
**credits** | **Float** | Remaining credits of the user. This can either be \"User Limit\" or \"Send Limit\" depending on the plan. |
|
9
9
|
|
10
10
|
|
data/docs/GetCampaignStats.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
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]
|
7
7
|
**unique_clicks** | **Integer** | Number of unique clicks for the campaign |
|
8
8
|
**clickers** | **Integer** | Number of clicks for the campaign |
|
9
9
|
**complaints** | **Integer** | Number of complaints (Spam reports) for the campaign |
|
@@ -3,10 +3,10 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**messages_sent** | [**Array<
|
7
|
-
**hard_bounces** | [**Array<
|
8
|
-
**soft_bounces** | [**Array<
|
9
|
-
**complaints** | [**Array<
|
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]
|
10
10
|
**unsubscriptions** | [**GetContactCampaignStatsUnsubscriptions**](GetContactCampaignStatsUnsubscriptions.md) | | [optional]
|
11
11
|
**opened** | [**Array<GetContactCampaignStatsOpened>**](GetContactCampaignStatsOpened.md) | | [optional]
|
12
12
|
**clicked** | [**Array<GetContactCampaignStatsClicked>**](GetContactCampaignStatsClicked.md) | | [optional]
|
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**campaign_id** | **Integer** | ID of the campaign which generated the event |
|
7
|
-
**links** | [**Array<
|
7
|
+
**links** | [**Array<GetExtendedContactDetailsStatisticsLinks>**](GetExtendedContactDetailsStatisticsLinks.md) | |
|
8
8
|
|
9
9
|
|
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**campaign_id** | **Integer** | ID of the campaign which generated the event |
|
7
7
|
**count** | **Integer** | Number of openings of the campaign |
|
8
|
-
**event_time** | **
|
8
|
+
**event_time** | **String** | Date of the event |
|
9
9
|
**ip** | **String** | IP from which the user has opened the campaign |
|
10
10
|
|
11
11
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**user_unsubscription** | [**Array<
|
7
|
-
**admin_unsubscription** | [**Array<
|
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 |
|
8
8
|
|
9
9
|
|
data/docs/GetEmailCampaign.md
CHANGED
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
|
|
16
16
|
**reply_to** | **String** | Email defined as the \"Reply to\" of the campaign |
|
17
17
|
**to_field** | **String** | Customisation of the \"to\" field of the campaign |
|
18
18
|
**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]
|
20
20
|
**tag** | **String** | Tag of the campaign |
|
21
21
|
**created_at** | **String** | Creation date of the campaign (YYYY-MM-DD HH:mm:ss) |
|
22
22
|
**modified_at** | **String** | Date of last modification of the campaign (YYYY-MM-DD HH:mm:ss) |
|
@@ -5,10 +5,12 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**email** | **String** | Email address which generates the event |
|
7
7
|
**date** | **Date** | Date on which the event has been generated |
|
8
|
+
**subject** | **String** | Subject of the event | [optional]
|
8
9
|
**message_id** | **String** | Message ID which generated the event |
|
9
10
|
**event** | **String** | Event which occured |
|
10
11
|
**reason** | **String** | Reason of bounce (only availble if the event is hardbounce or softbounce) |
|
11
12
|
**tag** | **String** | Tag of the email which generated the event |
|
12
13
|
**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]
|
13
15
|
|
14
16
|
|
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
|
|
16
16
|
**reply_to** | **String** | Email defined as the \"Reply to\" of the campaign |
|
17
17
|
**to_field** | **String** | Customisation of the \"to\" field of the campaign |
|
18
18
|
**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]
|
20
20
|
**tag** | **String** | Tag of the campaign |
|
21
21
|
**created_at** | **String** | Creation date of the campaign (YYYY-MM-DD HH:mm:ss) |
|
22
22
|
**modified_at** | **String** | Date of last modification of the campaign (YYYY-MM-DD HH:mm:ss) |
|
@@ -11,5 +11,6 @@ Name | Type | Description | Notes
|
|
11
11
|
**list_ids** | **Array<Integer>** | |
|
12
12
|
**list_unsubscribed** | **Array<Integer>** | | [optional]
|
13
13
|
**attributes** | **Hash<String, String>** | |
|
14
|
+
**statistics** | [**GetExtendedContactDetailsStatistics**](GetExtendedContactDetailsStatistics.md) | | [optional]
|
14
15
|
|
15
16
|
|
@@ -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
|
+
|
@@ -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
|
+
|
@@ -1,10 +1,10 @@
|
|
1
|
-
# SibApiV3Sdk::
|
1
|
+
# SibApiV3Sdk::GetExtendedContactDetailsStatisticsLinks
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**count** | **Integer** | Number of clicks on this link for the campaign |
|
7
|
-
**event_time** | **
|
7
|
+
**event_time** | **String** | Date of the event |
|
8
8
|
**ip** | **String** | IP from which the user has clicked on the link |
|
9
9
|
**url** | **String** | URL of the clicked link |
|
10
10
|
|
@@ -1,9 +1,9 @@
|
|
1
|
-
# SibApiV3Sdk::
|
1
|
+
# SibApiV3Sdk::GetExtendedContactDetailsStatisticsMessagesSent
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**campaign_id** | **Integer** | ID of the campaign which generated the event |
|
7
|
-
**event_time** | **
|
7
|
+
**event_time** | **String** | Date of the event |
|
8
8
|
|
9
9
|
|
@@ -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
|
+
|
@@ -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
|
+
|
@@ -1,9 +1,9 @@
|
|
1
|
-
# SibApiV3Sdk::
|
1
|
+
# SibApiV3Sdk::GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**event_time** | **
|
6
|
+
**event_time** | **String** | Date of the event |
|
7
7
|
**ip** | **String** | IP from which the user has been unsubscribed |
|
8
8
|
|
9
9
|
|
@@ -1,10 +1,10 @@
|
|
1
|
-
# SibApiV3Sdk::
|
1
|
+
# SibApiV3Sdk::GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**campaign_id** | **Integer** | ID of the campaign which generated the event |
|
7
|
-
**event_time** | **
|
7
|
+
**event_time** | **String** | Date of the event |
|
8
8
|
**ip** | **String** | IP from which the user has unsubscribed |
|
9
9
|
|
10
10
|
|
data/docs/GetExtendedList.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**total_blacklisted** | **Integer** | Number of blacklisted contacts in the list |
|
9
9
|
**total_subscribers** | **Integer** | Number of contacts in the list |
|
10
10
|
**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) |
|
12
12
|
**campaign_stats** | [**Array<GetExtendedListCampaignStats>**](GetExtendedListCampaignStats.md) | | [optional]
|
13
13
|
**dynamic_list** | **BOOLEAN** | Status telling if the list is dynamic or not (true=dynamic, false=not dynamic) | [optional]
|
14
14
|
|
data/docs/GetLists.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
+
**lists** | **Array<Object>** | Listing of all the lists available in your account |
|
6
7
|
**count** | **Integer** | Number of lists in your account |
|
7
|
-
**lists** | [**Array<GetListsLists>**](GetListsLists.md) | Listing of all the lists available in your account |
|
8
8
|
|
9
9
|
|
data/docs/GetWebhook.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**description** | **String** | Description of the webhook |
|
9
9
|
**events** | **Array<String>** | |
|
10
10
|
**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) |
|
13
13
|
|
14
14
|
|
data/lib/sib-api-v3-sdk.rb
CHANGED
@@ -63,13 +63,9 @@ require 'sib-api-v3-sdk/models/get_children_list'
|
|
63
63
|
require 'sib-api-v3-sdk/models/get_client'
|
64
64
|
require 'sib-api-v3-sdk/models/get_contact_campaign_stats'
|
65
65
|
require 'sib-api-v3-sdk/models/get_contact_campaign_stats_clicked'
|
66
|
-
require 'sib-api-v3-sdk/models/get_contact_campaign_stats_links'
|
67
|
-
require 'sib-api-v3-sdk/models/get_contact_campaign_stats_messages_sent'
|
68
66
|
require 'sib-api-v3-sdk/models/get_contact_campaign_stats_opened'
|
69
67
|
require 'sib-api-v3-sdk/models/get_contact_campaign_stats_transac_attributes'
|
70
68
|
require 'sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions'
|
71
|
-
require 'sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions_admin_unsubscription'
|
72
|
-
require 'sib-api-v3-sdk/models/get_contact_campaign_stats_unsubscriptions_user_unsubscription'
|
73
69
|
require 'sib-api-v3-sdk/models/get_contact_details'
|
74
70
|
require 'sib-api-v3-sdk/models/get_contacts'
|
75
71
|
require 'sib-api-v3-sdk/models/get_email_campaigns'
|
@@ -79,6 +75,14 @@ require 'sib-api-v3-sdk/models/get_extended_campaign_overview_sender'
|
|
79
75
|
require 'sib-api-v3-sdk/models/get_extended_campaign_stats'
|
80
76
|
require 'sib-api-v3-sdk/models/get_extended_campaign_stats_links_stats'
|
81
77
|
require 'sib-api-v3-sdk/models/get_extended_client_address'
|
78
|
+
require 'sib-api-v3-sdk/models/get_extended_contact_details_statistics'
|
79
|
+
require 'sib-api-v3-sdk/models/get_extended_contact_details_statistics_clicked'
|
80
|
+
require 'sib-api-v3-sdk/models/get_extended_contact_details_statistics_links'
|
81
|
+
require 'sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent'
|
82
|
+
require 'sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened'
|
83
|
+
require 'sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions'
|
84
|
+
require 'sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription'
|
85
|
+
require 'sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription'
|
82
86
|
require 'sib-api-v3-sdk/models/get_extended_list_campaign_stats'
|
83
87
|
require 'sib-api-v3-sdk/models/get_folder'
|
84
88
|
require 'sib-api-v3-sdk/models/get_folder_lists'
|
@@ -89,8 +93,6 @@ require 'sib-api-v3-sdk/models/get_ips'
|
|
89
93
|
require 'sib-api-v3-sdk/models/get_ips_from_sender'
|
90
94
|
require 'sib-api-v3-sdk/models/get_list'
|
91
95
|
require 'sib-api-v3-sdk/models/get_lists'
|
92
|
-
require 'sib-api-v3-sdk/models/get_lists_folder'
|
93
|
-
require 'sib-api-v3-sdk/models/get_lists_lists'
|
94
96
|
require 'sib-api-v3-sdk/models/get_process'
|
95
97
|
require 'sib-api-v3-sdk/models/get_processes'
|
96
98
|
require 'sib-api-v3-sdk/models/get_reports'
|
@@ -150,10 +150,6 @@ module SibApiV3Sdk
|
|
150
150
|
# @return Array for valid properies with the reasons
|
151
151
|
def list_invalid_properties
|
152
152
|
invalid_properties = Array.new
|
153
|
-
if @list_id.nil?
|
154
|
-
invalid_properties.push("invalid value for 'list_id', list_id cannot be nil.")
|
155
|
-
end
|
156
|
-
|
157
153
|
if @unique_clicks.nil?
|
158
154
|
invalid_properties.push("invalid value for 'unique_clicks', unique_clicks cannot be nil.")
|
159
155
|
end
|
@@ -204,7 +200,6 @@ module SibApiV3Sdk
|
|
204
200
|
# Check to see if the all the properties in the model are valid
|
205
201
|
# @return true if the model is valid
|
206
202
|
def valid?
|
207
|
-
return false if @list_id.nil?
|
208
203
|
return false if @unique_clicks.nil?
|
209
204
|
return false if @clickers.nil?
|
210
205
|
return false if @complaints.nil?
|
@@ -49,10 +49,10 @@ module SibApiV3Sdk
|
|
49
49
|
# Attribute type mapping.
|
50
50
|
def self.swagger_types
|
51
51
|
{
|
52
|
-
:'messages_sent' => :'Array<
|
53
|
-
:'hard_bounces' => :'Array<
|
54
|
-
:'soft_bounces' => :'Array<
|
55
|
-
:'complaints' => :'Array<
|
52
|
+
:'messages_sent' => :'Array<GetExtendedContactDetailsStatisticsMessagesSent>',
|
53
|
+
:'hard_bounces' => :'Array<GetExtendedContactDetailsStatisticsMessagesSent>',
|
54
|
+
:'soft_bounces' => :'Array<GetExtendedContactDetailsStatisticsMessagesSent>',
|
55
|
+
:'complaints' => :'Array<GetExtendedContactDetailsStatisticsMessagesSent>',
|
56
56
|
:'unsubscriptions' => :'GetContactCampaignStatsUnsubscriptions',
|
57
57
|
:'opened' => :'Array<GetContactCampaignStatsOpened>',
|
58
58
|
:'clicked' => :'Array<GetContactCampaignStatsClicked>',
|
@@ -43,7 +43,7 @@ module SibApiV3Sdk
|
|
43
43
|
{
|
44
44
|
:'campaign_id' => :'Integer',
|
45
45
|
:'count' => :'Integer',
|
46
|
-
:'event_time' => :'
|
46
|
+
:'event_time' => :'String',
|
47
47
|
:'ip' => :'String'
|
48
48
|
}
|
49
49
|
end
|
@@ -90,6 +90,10 @@ module SibApiV3Sdk
|
|
90
90
|
invalid_properties.push("invalid value for 'event_time', event_time cannot be nil.")
|
91
91
|
end
|
92
92
|
|
93
|
+
if @event_time !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
|
94
|
+
invalid_properties.push("invalid value for 'event_time', must conform to the pattern /^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/.")
|
95
|
+
end
|
96
|
+
|
93
97
|
if @ip.nil?
|
94
98
|
invalid_properties.push("invalid value for 'ip', ip cannot be nil.")
|
95
99
|
end
|
@@ -103,10 +107,25 @@ module SibApiV3Sdk
|
|
103
107
|
return false if @campaign_id.nil?
|
104
108
|
return false if @count.nil?
|
105
109
|
return false if @event_time.nil?
|
110
|
+
return false if @event_time !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
|
106
111
|
return false if @ip.nil?
|
107
112
|
return true
|
108
113
|
end
|
109
114
|
|
115
|
+
# Custom attribute writer method with validation
|
116
|
+
# @param [Object] event_time Value to be assigned
|
117
|
+
def event_time=(event_time)
|
118
|
+
if event_time.nil?
|
119
|
+
fail ArgumentError, "event_time cannot be nil"
|
120
|
+
end
|
121
|
+
|
122
|
+
if event_time !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
|
123
|
+
fail ArgumentError, "invalid value for 'event_time', must conform to the pattern /^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/."
|
124
|
+
end
|
125
|
+
|
126
|
+
@event_time = event_time
|
127
|
+
end
|
128
|
+
|
110
129
|
# Checks equality by comparing each attribute.
|
111
130
|
# @param [Object] Object to be compared
|
112
131
|
def ==(o)
|