sib-api-v3-sdk 7.1.0 → 7.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +5 -0
- data/docs/BlockDomain.md +8 -0
- data/docs/ContactsApi.md +18 -6
- data/docs/CreateSmtpTemplateSender.md +1 -1
- data/docs/EmailCampaignsApi.md +3 -1
- data/docs/FoldersApi.md +9 -3
- data/docs/GetBlockedDomains.md +8 -0
- data/docs/GetChildDomain.md +2 -2
- data/docs/GetChildrenList.md +1 -1
- data/docs/GetEmailCampaign.md +2 -2
- data/docs/GetEmailCampaigns.md +1 -1
- data/docs/GetEmailEventReportEvents.md +1 -0
- data/docs/GetExtendedCampaignOverview.md +2 -2
- data/docs/GetFolderLists.md +2 -2
- data/docs/GetLists.md +2 -2
- data/docs/GetProcesses.md +1 -1
- data/docs/GetSmsCampaign.md +1 -1
- data/docs/GetSmsCampaignOverview.md +1 -1
- data/docs/GetSmsCampaigns.md +1 -1
- data/docs/GetSmsEventReportEvents.md +4 -4
- data/docs/GetTransacAggregatedSmsReport.md +10 -10
- data/docs/GetTransacSmsReportReports.md +10 -10
- data/docs/ListsApi.md +9 -3
- data/docs/ProcessApi.md +3 -1
- data/docs/SMSCampaignsApi.md +3 -1
- data/docs/SendSmtpEmailSender.md +3 -3
- data/docs/TransactionalEmailsApi.md +187 -5
- data/docs/TransactionalSMSApi.md +6 -2
- data/lib/sib-api-v3-sdk.rb +2 -0
- data/lib/sib-api-v3-sdk/api/account_api.rb +10 -0
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +10 -0
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +40 -0
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +16 -0
- data/lib/sib-api-v3-sdk/api/folders_api.rb +22 -0
- data/lib/sib-api-v3-sdk/api/lists_api.rb +28 -0
- data/lib/sib-api-v3-sdk/api/process_api.rb +16 -0
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +10 -0
- data/lib/sib-api-v3-sdk/api/senders_api.rb +10 -0
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +16 -0
- data/lib/sib-api-v3-sdk/api/transactional_emails_api.rb +196 -2
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +22 -0
- data/lib/sib-api-v3-sdk/api/webhooks_api.rb +10 -0
- data/lib/sib-api-v3-sdk/models/block_domain.rb +189 -0
- data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +0 -5
- data/lib/sib-api-v3-sdk/models/get_blocked_domains.rb +192 -0
- data/lib/sib-api-v3-sdk/models/get_child_domain.rb +0 -10
- data/lib/sib-api-v3-sdk/models/get_children_list.rb +0 -5
- data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +0 -10
- data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +0 -5
- data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +16 -6
- data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +0 -10
- data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +0 -10
- data/lib/sib-api-v3-sdk/models/get_lists.rb +0 -10
- data/lib/sib-api-v3-sdk/models/get_processes.rb +0 -5
- data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +0 -5
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +0 -5
- data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +0 -5
- data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +0 -20
- data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +0 -50
- data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +0 -50
- data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +4 -9
- data/lib/sib-api-v3-sdk/version.rb +1 -1
- data/spec/api/contacts_api_spec.rb +5 -0
- data/spec/api/email_campaigns_api_spec.rb +1 -0
- data/spec/api/folders_api_spec.rb +2 -0
- data/spec/api/lists_api_spec.rb +3 -0
- data/spec/api/process_api_spec.rb +1 -0
- data/spec/api/sms_campaigns_api_spec.rb +1 -0
- data/spec/api/transactional_emails_api_spec.rb +40 -0
- data/spec/api/transactional_sms_api_spec.rb +2 -0
- data/spec/models/block_domain_spec.rb +41 -0
- data/spec/models/get_blocked_domains_spec.rb +41 -0
- data/spec/models/get_email_event_report_events_spec.rb +7 -1
- data/testfile.rb +26 -0
- metadata +11 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 95ade02f653574e924189611a093095dbaac0944c99944d9f951724b71596203
|
4
|
+
data.tar.gz: 1ae2a4063f25b0bf37f6ab3e771e47de3695dd12979189c88b4811df38ae1e58
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2fd6e9d4b214e146ace079496831a93bb045f6cceb1ac20f9f25b3eead45505d2d49f6b563a35cc7eaed984e9b732556ffe96ab9ef7a84982320bc9420b09bbc
|
7
|
+
data.tar.gz: 7a6258cd6bd43c18e00625836c39c87ec71d6373a507ba69c4672bb821011d4562cfaa9175be1984f0c2f66d7a645f52a78de5fffec3e6c125fbf63e21eeb7ad
|
data/README.md
CHANGED
@@ -178,10 +178,13 @@ Class | Method | HTTP request | Description
|
|
178
178
|
*SibApiV3Sdk::SendersApi* | [**get_ips_from_sender**](docs/SendersApi.md#get_ips_from_sender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender
|
179
179
|
*SibApiV3Sdk::SendersApi* | [**get_senders**](docs/SendersApi.md#get_senders) | **GET** /senders | Get the list of all your senders
|
180
180
|
*SibApiV3Sdk::SendersApi* | [**update_sender**](docs/SendersApi.md#update_sender) | **PUT** /senders/{senderId} | Update a sender
|
181
|
+
*SibApiV3Sdk::TransactionalEmailsApi* | [**block_new_domain**](docs/TransactionalEmailsApi.md#block_new_domain) | **POST** /smtp/blockedDomains | Add a new domain to the list of blocked domains
|
181
182
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**create_smtp_template**](docs/TransactionalEmailsApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
|
183
|
+
*SibApiV3Sdk::TransactionalEmailsApi* | [**delete_blocked_domain**](docs/TransactionalEmailsApi.md#delete_blocked_domain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains
|
182
184
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**delete_hardbounces**](docs/TransactionalEmailsApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
|
183
185
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**delete_smtp_template**](docs/TransactionalEmailsApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
|
184
186
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_aggregated_smtp_report**](docs/TransactionalEmailsApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
|
187
|
+
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_blocked_domains**](docs/TransactionalEmailsApi.md#get_blocked_domains) | **GET** /smtp/blockedDomains | Get the list of blocked domains
|
185
188
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_email_event_report**](docs/TransactionalEmailsApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
|
186
189
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_smtp_report**](docs/TransactionalEmailsApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
|
187
190
|
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_smtp_template**](docs/TransactionalEmailsApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
|
@@ -217,6 +220,7 @@ Class | Method | HTTP request | Description
|
|
217
220
|
- [SibApiV3Sdk::AddChildDomain](docs/AddChildDomain.md)
|
218
221
|
- [SibApiV3Sdk::AddContactToList](docs/AddContactToList.md)
|
219
222
|
- [SibApiV3Sdk::AddCredits](docs/AddCredits.md)
|
223
|
+
- [SibApiV3Sdk::BlockDomain](docs/BlockDomain.md)
|
220
224
|
- [SibApiV3Sdk::CreateAttribute](docs/CreateAttribute.md)
|
221
225
|
- [SibApiV3Sdk::CreateAttributeEnumeration](docs/CreateAttributeEnumeration.md)
|
222
226
|
- [SibApiV3Sdk::CreateChild](docs/CreateChild.md)
|
@@ -251,6 +255,7 @@ Class | Method | HTTP request | Description
|
|
251
255
|
- [SibApiV3Sdk::GetAttributes](docs/GetAttributes.md)
|
252
256
|
- [SibApiV3Sdk::GetAttributesAttributes](docs/GetAttributesAttributes.md)
|
253
257
|
- [SibApiV3Sdk::GetAttributesEnumeration](docs/GetAttributesEnumeration.md)
|
258
|
+
- [SibApiV3Sdk::GetBlockedDomains](docs/GetBlockedDomains.md)
|
254
259
|
- [SibApiV3Sdk::GetCampaignOverview](docs/GetCampaignOverview.md)
|
255
260
|
- [SibApiV3Sdk::GetCampaignRecipients](docs/GetCampaignRecipients.md)
|
256
261
|
- [SibApiV3Sdk::GetCampaignStats](docs/GetCampaignStats.md)
|
data/docs/BlockDomain.md
ADDED
data/docs/ContactsApi.md
CHANGED
@@ -807,7 +807,8 @@ api_instance = SibApiV3Sdk::ContactsApi.new
|
|
807
807
|
opts = {
|
808
808
|
limit: 50, # Integer | Number of documents per page
|
809
809
|
offset: 0, # Integer | Index of the first document of the page
|
810
|
-
modified_since: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
810
|
+
modified_since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
811
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
811
812
|
}
|
812
813
|
|
813
814
|
begin
|
@@ -826,6 +827,7 @@ Name | Type | Description | Notes
|
|
826
827
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
827
828
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
828
829
|
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
830
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
829
831
|
|
830
832
|
### Return type
|
831
833
|
|
@@ -871,7 +873,8 @@ list_id = 789 # Integer | Id of the list
|
|
871
873
|
opts = {
|
872
874
|
modified_since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
873
875
|
limit: 50, # Integer | Number of documents per page
|
874
|
-
offset: 0 # Integer | Index of the first document of the page
|
876
|
+
offset: 0, # Integer | Index of the first document of the page
|
877
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
875
878
|
}
|
876
879
|
|
877
880
|
begin
|
@@ -891,6 +894,7 @@ Name | Type | Description | Notes
|
|
891
894
|
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
892
895
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
893
896
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
897
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
894
898
|
|
895
899
|
### Return type
|
896
900
|
|
@@ -992,7 +996,8 @@ folder_id = 789 # Integer | Id of the folder
|
|
992
996
|
|
993
997
|
opts = {
|
994
998
|
limit: 10, # Integer | Number of documents per page
|
995
|
-
offset: 0 # Integer | Index of the first document of the page
|
999
|
+
offset: 0, # Integer | Index of the first document of the page
|
1000
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
996
1001
|
}
|
997
1002
|
|
998
1003
|
begin
|
@@ -1011,6 +1016,7 @@ Name | Type | Description | Notes
|
|
1011
1016
|
**folder_id** | **Integer**| Id of the folder |
|
1012
1017
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
1013
1018
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
1019
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
1014
1020
|
|
1015
1021
|
### Return type
|
1016
1022
|
|
@@ -1028,7 +1034,7 @@ Name | Type | Description | Notes
|
|
1028
1034
|
|
1029
1035
|
|
1030
1036
|
# **get_folders**
|
1031
|
-
> GetFolders get_folders(limit, offset)
|
1037
|
+
> GetFolders get_folders(limit, offset, opts)
|
1032
1038
|
|
1033
1039
|
Get all folders
|
1034
1040
|
|
@@ -1055,10 +1061,13 @@ limit = 10 # Integer | Number of documents per page
|
|
1055
1061
|
|
1056
1062
|
offset = 0 # Integer | Index of the first document of the page
|
1057
1063
|
|
1064
|
+
opts = {
|
1065
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
1066
|
+
}
|
1058
1067
|
|
1059
1068
|
begin
|
1060
1069
|
#Get all folders
|
1061
|
-
result = api_instance.get_folders(limit, offset)
|
1070
|
+
result = api_instance.get_folders(limit, offset, opts)
|
1062
1071
|
p result
|
1063
1072
|
rescue SibApiV3Sdk::ApiError => e
|
1064
1073
|
puts "Exception when calling ContactsApi->get_folders: #{e}"
|
@@ -1071,6 +1080,7 @@ Name | Type | Description | Notes
|
|
1071
1080
|
------------- | ------------- | ------------- | -------------
|
1072
1081
|
**limit** | **Integer**| Number of documents per page | [default to 10]
|
1073
1082
|
**offset** | **Integer**| Index of the first document of the page | [default to 0]
|
1083
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
1074
1084
|
|
1075
1085
|
### Return type
|
1076
1086
|
|
@@ -1170,7 +1180,8 @@ api_instance = SibApiV3Sdk::ContactsApi.new
|
|
1170
1180
|
|
1171
1181
|
opts = {
|
1172
1182
|
limit: 10, # Integer | Number of documents per page
|
1173
|
-
offset: 0 # Integer | Index of the first document of the page
|
1183
|
+
offset: 0, # Integer | Index of the first document of the page
|
1184
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
1174
1185
|
}
|
1175
1186
|
|
1176
1187
|
begin
|
@@ -1188,6 +1199,7 @@ Name | Type | Description | Notes
|
|
1188
1199
|
------------- | ------------- | ------------- | -------------
|
1189
1200
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
1190
1201
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
1202
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
1191
1203
|
|
1192
1204
|
### Return type
|
1193
1205
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**name** | **String** | Name of the sender. If not passed, will be set to default | [optional]
|
7
|
-
**email** | **String** | Email of the sender |
|
7
|
+
**email** | **String** | Email of the sender | [optional]
|
8
8
|
**id** | **Integer** | Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional]
|
9
9
|
|
10
10
|
|
data/docs/EmailCampaignsApi.md
CHANGED
@@ -339,7 +339,8 @@ opts = {
|
|
339
339
|
start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
340
340
|
end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
|
341
341
|
limit: 500, # Integer | Number of documents per page
|
342
|
-
offset: 0 # Integer | Index of the first document in the page
|
342
|
+
offset: 0, # Integer | Index of the first document in the page
|
343
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
343
344
|
}
|
344
345
|
|
345
346
|
begin
|
@@ -361,6 +362,7 @@ Name | Type | Description | Notes
|
|
361
362
|
**end_date** | **DateTime**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
|
362
363
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 500]
|
363
364
|
**offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
|
365
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
364
366
|
|
365
367
|
### Return type
|
366
368
|
|
data/docs/FoldersApi.md
CHANGED
@@ -210,7 +210,8 @@ folder_id = 789 # Integer | Id of the folder
|
|
210
210
|
|
211
211
|
opts = {
|
212
212
|
limit: 10, # Integer | Number of documents per page
|
213
|
-
offset: 0 # Integer | Index of the first document of the page
|
213
|
+
offset: 0, # Integer | Index of the first document of the page
|
214
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
214
215
|
}
|
215
216
|
|
216
217
|
begin
|
@@ -229,6 +230,7 @@ Name | Type | Description | Notes
|
|
229
230
|
**folder_id** | **Integer**| Id of the folder |
|
230
231
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
231
232
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
233
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
232
234
|
|
233
235
|
### Return type
|
234
236
|
|
@@ -246,7 +248,7 @@ Name | Type | Description | Notes
|
|
246
248
|
|
247
249
|
|
248
250
|
# **get_folders**
|
249
|
-
> GetFolders get_folders(limit, offset)
|
251
|
+
> GetFolders get_folders(limit, offset, opts)
|
250
252
|
|
251
253
|
Get all folders
|
252
254
|
|
@@ -273,10 +275,13 @@ limit = 10 # Integer | Number of documents per page
|
|
273
275
|
|
274
276
|
offset = 0 # Integer | Index of the first document of the page
|
275
277
|
|
278
|
+
opts = {
|
279
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
280
|
+
}
|
276
281
|
|
277
282
|
begin
|
278
283
|
#Get all folders
|
279
|
-
result = api_instance.get_folders(limit, offset)
|
284
|
+
result = api_instance.get_folders(limit, offset, opts)
|
280
285
|
p result
|
281
286
|
rescue SibApiV3Sdk::ApiError => e
|
282
287
|
puts "Exception when calling FoldersApi->get_folders: #{e}"
|
@@ -289,6 +294,7 @@ Name | Type | Description | Notes
|
|
289
294
|
------------- | ------------- | ------------- | -------------
|
290
295
|
**limit** | **Integer**| Number of documents per page | [default to 10]
|
291
296
|
**offset** | **Integer**| Index of the first document of the page | [default to 0]
|
297
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
292
298
|
|
293
299
|
### Return type
|
294
300
|
|
data/docs/GetChildDomain.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**domain** | **String** | Sender domain |
|
7
|
-
**active** | **BOOLEAN** | indicates whether a domain is verified or not |
|
6
|
+
**domain** | **String** | Sender domain | [optional]
|
7
|
+
**active** | **BOOLEAN** | indicates whether a domain is verified or not | [optional]
|
8
8
|
|
9
9
|
|
data/docs/GetChildrenList.md
CHANGED
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**children** | **Array<Object>** | Your children's account information | [optional]
|
7
|
-
**count** | **Integer** | Number of child accounts |
|
7
|
+
**count** | **Integer** | Number of child accounts | [optional]
|
8
8
|
|
9
9
|
|
data/docs/GetEmailCampaign.md
CHANGED
@@ -21,10 +21,10 @@ Name | Type | Description | Notes
|
|
21
21
|
**footer** | **String** | Footer of the campaign |
|
22
22
|
**sender** | [**GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) | |
|
23
23
|
**reply_to** | **String** | Email defined as the \"Reply to\" of the campaign |
|
24
|
-
**to_field** | **String** | Customisation of the \"to\" field of the campaign |
|
24
|
+
**to_field** | **String** | Customisation of the \"to\" field of the campaign | [optional]
|
25
25
|
**html_content** | **String** | HTML content of the campaign |
|
26
26
|
**share_link** | **String** | Link to share the campaign on social medias | [optional]
|
27
|
-
**tag** | **String** | Tag of the campaign |
|
27
|
+
**tag** | **String** | Tag of the campaign | [optional]
|
28
28
|
**created_at** | **DateTime** | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
29
29
|
**modified_at** | **DateTime** | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
30
30
|
**inline_image_activation** | **BOOLEAN** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. | [optional]
|
data/docs/GetEmailCampaigns.md
CHANGED
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**campaigns** | **Array<Object>** | | [optional]
|
7
|
-
**count** | **Integer** | Number of Email campaigns retrieved |
|
7
|
+
**count** | **Integer** | Number of Email campaigns retrieved | [optional]
|
8
8
|
|
9
9
|
|
@@ -13,5 +13,6 @@ Name | Type | Description | Notes
|
|
13
13
|
**ip** | **String** | IP from which the user has opened the email or clicked on the link (only available if the event is opened or clicks) | [optional]
|
14
14
|
**link** | **String** | The link which is sent to the user (only available if the event is requests or opened or clicks) | [optional]
|
15
15
|
**from** | **String** | Sender email from which the emails are sent | [optional]
|
16
|
+
**template_id** | **Integer** | ID of the template (only available if the email is template based) | [optional]
|
16
17
|
|
17
18
|
|
@@ -21,10 +21,10 @@ Name | Type | Description | Notes
|
|
21
21
|
**footer** | **String** | Footer of the campaign |
|
22
22
|
**sender** | [**GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) | |
|
23
23
|
**reply_to** | **String** | Email defined as the \"Reply to\" of the campaign |
|
24
|
-
**to_field** | **String** | Customisation of the \"to\" field of the campaign |
|
24
|
+
**to_field** | **String** | Customisation of the \"to\" field of the campaign | [optional]
|
25
25
|
**html_content** | **String** | HTML content of the campaign |
|
26
26
|
**share_link** | **String** | Link to share the campaign on social medias | [optional]
|
27
|
-
**tag** | **String** | Tag of the campaign |
|
27
|
+
**tag** | **String** | Tag of the campaign | [optional]
|
28
28
|
**created_at** | **DateTime** | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
29
29
|
**modified_at** | **DateTime** | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
30
30
|
**inline_image_activation** | **BOOLEAN** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. | [optional]
|
data/docs/GetFolderLists.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**lists** | **Array<Object>** | |
|
7
|
-
**count** | **Integer** | Number of lists in the folder |
|
6
|
+
**lists** | **Array<Object>** | | [optional]
|
7
|
+
**count** | **Integer** | Number of lists in the folder | [optional]
|
8
8
|
|
9
9
|
|
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 |
|
7
|
-
**count** | **Integer** | Number of lists in your account |
|
6
|
+
**lists** | **Array<Object>** | Listing of all the lists available in your account | [optional]
|
7
|
+
**count** | **Integer** | Number of lists in your account | [optional]
|
8
8
|
|
9
9
|
|
data/docs/GetProcesses.md
CHANGED
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**processes** | [**Array<GetProcess>**](GetProcess.md) | List of processes available on your account | [optional]
|
7
|
-
**count** | **Integer** | Number of processes available on your account |
|
7
|
+
**count** | **Integer** | Number of processes available on your account | [optional]
|
8
8
|
|
9
9
|
|
data/docs/GetSmsCampaign.md
CHANGED
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**name** | **String** | Name of the SMS Campaign |
|
8
8
|
**status** | **String** | Status of the SMS Campaign |
|
9
9
|
**content** | **String** | Content of the SMS Campaign |
|
10
|
-
**scheduled_at** | **DateTime** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
|
10
|
+
**scheduled_at** | **DateTime** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional]
|
11
11
|
**sender** | **String** | Sender of the SMS Campaign |
|
12
12
|
**created_at** | **DateTime** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
13
13
|
**modified_at** | **DateTime** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**name** | **String** | Name of the SMS Campaign |
|
8
8
|
**status** | **String** | Status of the SMS Campaign |
|
9
9
|
**content** | **String** | Content of the SMS Campaign |
|
10
|
-
**scheduled_at** | **DateTime** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
|
10
|
+
**scheduled_at** | **DateTime** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional]
|
11
11
|
**sender** | **String** | Sender of the SMS Campaign |
|
12
12
|
**created_at** | **DateTime** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
13
13
|
**modified_at** | **DateTime** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
data/docs/GetSmsCampaigns.md
CHANGED
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**campaigns** | **Array<Object>** | | [optional]
|
7
|
-
**count** | **Integer** | Number of SMS campaigns retrieved |
|
7
|
+
**count** | **Integer** | Number of SMS campaigns retrieved | [optional]
|
8
8
|
|
9
9
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**phone_number** | **String** | Phone number which has generated the event |
|
7
|
-
**date** | **DateTime** | UTC date-time on which the event has been generated |
|
8
|
-
**message_id** | **String** | Message ID which generated the event |
|
9
|
-
**event** | **String** | Event which occurred |
|
6
|
+
**phone_number** | **String** | Phone number which has generated the event | [optional]
|
7
|
+
**date** | **DateTime** | UTC date-time on which the event has been generated | [optional]
|
8
|
+
**message_id** | **String** | Message ID which generated the event | [optional]
|
9
|
+
**event** | **String** | Event which occurred | [optional]
|
10
10
|
**reason** | **String** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional]
|
11
11
|
**reply** | **String** | | [optional]
|
12
12
|
**tag** | **String** | Tag of the SMS which generated the event | [optional]
|
@@ -3,15 +3,15 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**range** | **String** | Time frame of the report |
|
7
|
-
**requests** | **Integer** | Number of requests for the timeframe |
|
8
|
-
**delivered** | **Integer** | Number of delivered SMS for the timeframe |
|
9
|
-
**hard_bounces** | **Integer** | Number of hardbounces for the timeframe |
|
10
|
-
**soft_bounces** | **Integer** | Number of softbounces for the timeframe |
|
11
|
-
**blocked** | **Integer** | Number of blocked contact for the timeframe |
|
12
|
-
**unsubscribed** | **Integer** | Number of unsubscription for the timeframe |
|
13
|
-
**replied** | **Integer** | Number of answered SMS for the timeframe |
|
14
|
-
**accepted** | **Integer** | Number of accepted for the timeframe |
|
15
|
-
**rejected** | **Integer** | Number of rejected for the timeframe |
|
6
|
+
**range** | **String** | Time frame of the report | [optional]
|
7
|
+
**requests** | **Integer** | Number of requests for the timeframe | [optional]
|
8
|
+
**delivered** | **Integer** | Number of delivered SMS for the timeframe | [optional]
|
9
|
+
**hard_bounces** | **Integer** | Number of hardbounces for the timeframe | [optional]
|
10
|
+
**soft_bounces** | **Integer** | Number of softbounces for the timeframe | [optional]
|
11
|
+
**blocked** | **Integer** | Number of blocked contact for the timeframe | [optional]
|
12
|
+
**unsubscribed** | **Integer** | Number of unsubscription for the timeframe | [optional]
|
13
|
+
**replied** | **Integer** | Number of answered SMS for the timeframe | [optional]
|
14
|
+
**accepted** | **Integer** | Number of accepted for the timeframe | [optional]
|
15
|
+
**rejected** | **Integer** | Number of rejected for the timeframe | [optional]
|
16
16
|
|
17
17
|
|
@@ -3,15 +3,15 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**date** | **Date** | Date for which statistics are retrieved |
|
7
|
-
**requests** | **Integer** | Number of requests for the date |
|
8
|
-
**delivered** | **Integer** | Number of delivered SMS for the date |
|
9
|
-
**hard_bounces** | **Integer** | Number of hardbounces for the date |
|
10
|
-
**soft_bounces** | **Integer** | Number of softbounces for the date |
|
11
|
-
**blocked** | **Integer** | Number of blocked contact for the date |
|
12
|
-
**unsubscribed** | **Integer** | Number of unsubscription for the date |
|
13
|
-
**replied** | **Integer** | Number of answered SMS for the date |
|
14
|
-
**accepted** | **Integer** | Number of accepted for the date |
|
15
|
-
**rejected** | **Integer** | Number of rejected for the date |
|
6
|
+
**date** | **Date** | Date for which statistics are retrieved | [optional]
|
7
|
+
**requests** | **Integer** | Number of requests for the date | [optional]
|
8
|
+
**delivered** | **Integer** | Number of delivered SMS for the date | [optional]
|
9
|
+
**hard_bounces** | **Integer** | Number of hardbounces for the date | [optional]
|
10
|
+
**soft_bounces** | **Integer** | Number of softbounces for the date | [optional]
|
11
|
+
**blocked** | **Integer** | Number of blocked contact for the date | [optional]
|
12
|
+
**unsubscribed** | **Integer** | Number of unsubscription for the date | [optional]
|
13
|
+
**replied** | **Integer** | Number of answered SMS for the date | [optional]
|
14
|
+
**accepted** | **Integer** | Number of accepted for the date | [optional]
|
15
|
+
**rejected** | **Integer** | Number of rejected for the date | [optional]
|
16
16
|
|
17
17
|
|
data/docs/ListsApi.md
CHANGED
@@ -217,7 +217,8 @@ list_id = 789 # Integer | Id of the list
|
|
217
217
|
opts = {
|
218
218
|
modified_since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
219
219
|
limit: 50, # Integer | Number of documents per page
|
220
|
-
offset: 0 # Integer | Index of the first document of the page
|
220
|
+
offset: 0, # Integer | Index of the first document of the page
|
221
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
221
222
|
}
|
222
223
|
|
223
224
|
begin
|
@@ -237,6 +238,7 @@ Name | Type | Description | Notes
|
|
237
238
|
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
238
239
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
239
240
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
241
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
240
242
|
|
241
243
|
### Return type
|
242
244
|
|
@@ -281,7 +283,8 @@ folder_id = 789 # Integer | Id of the folder
|
|
281
283
|
|
282
284
|
opts = {
|
283
285
|
limit: 10, # Integer | Number of documents per page
|
284
|
-
offset: 0 # Integer | Index of the first document of the page
|
286
|
+
offset: 0, # Integer | Index of the first document of the page
|
287
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
285
288
|
}
|
286
289
|
|
287
290
|
begin
|
@@ -300,6 +303,7 @@ Name | Type | Description | Notes
|
|
300
303
|
**folder_id** | **Integer**| Id of the folder |
|
301
304
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
302
305
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
306
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
303
307
|
|
304
308
|
### Return type
|
305
309
|
|
@@ -399,7 +403,8 @@ api_instance = SibApiV3Sdk::ListsApi.new
|
|
399
403
|
|
400
404
|
opts = {
|
401
405
|
limit: 10, # Integer | Number of documents per page
|
402
|
-
offset: 0 # Integer | Index of the first document of the page
|
406
|
+
offset: 0, # Integer | Index of the first document of the page
|
407
|
+
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
|
403
408
|
}
|
404
409
|
|
405
410
|
begin
|
@@ -417,6 +422,7 @@ Name | Type | Description | Notes
|
|
417
422
|
------------- | ------------- | ------------- | -------------
|
418
423
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
|
419
424
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
425
|
+
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
|
420
426
|
|
421
427
|
### Return type
|
422
428
|
|