sib-api-v3-sdk 5.2.1 → 5.2.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/docs/DeleteHardbounces.md +2 -2
- data/docs/SMSCampaignsApi.md +2 -5
- data/docs/SMTPApi.md +12 -12
- data/docs/TransactionalSMSApi.md +12 -12
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +4 -10
- data/lib/sib-api-v3-sdk/api/smtp_api.rb +12 -12
- data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +12 -12
- data/lib/sib-api-v3-sdk/models/delete_hardbounces.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_attributes_attributes.rb +2 -2
- data/lib/sib-api-v3-sdk/version.rb +1 -1
- data/spec/api/sms_campaigns_api_spec.rb +0 -1
- data/spec/api/smtp_api_spec.rb +6 -6
- data/spec/api/transactional_sms_api_spec.rb +6 -6
- data/spec/models/get_attributes_attributes_spec.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: bb4ff8d75ee2a788e04419e8b01331c4e963d6f6636ed1573c36de48cf502881
|
4
|
+
data.tar.gz: 358d03549ce436aadb920ce4966bc2531f40598800808ce60d478e9465d35784
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2949262efe9d3810942d47c677af7222463dba547d5c422eacefc63e716f6eca6d4651ec9ef33e4b22adaf563a7adb7a60155b2b93a374a24d34d40f19f7c355
|
7
|
+
data.tar.gz: 97d5b4ecd19e0efee43bc248270d2385741ba06a94c31c3b1ce933e5ffc896e3d55cfd589456df37169ebd29002fabef6744cb7882e075d56f2bbb709789bc70
|
data/docs/DeleteHardbounces.md
CHANGED
@@ -3,8 +3,8 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**start_date** | **
|
7
|
-
**end_date** | **
|
6
|
+
**start_date** | **String** | 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** | **String** | 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]
|
8
8
|
**contact_email** | **String** | Target a specific email address | [optional]
|
9
9
|
|
10
10
|
|
data/docs/SMSCampaignsApi.md
CHANGED
@@ -130,7 +130,7 @@ nil (empty response body)
|
|
130
130
|
|
131
131
|
|
132
132
|
# **get_sms_campaign**
|
133
|
-
> GetSmsCampaign get_sms_campaign(campaign_id
|
133
|
+
> GetSmsCampaign get_sms_campaign(campaign_id)
|
134
134
|
|
135
135
|
Get an SMS campaign
|
136
136
|
|
@@ -155,12 +155,10 @@ api_instance = SibApiV3Sdk::SMSCampaignsApi.new
|
|
155
155
|
|
156
156
|
campaign_id = 789 # Integer | id of the SMS campaign
|
157
157
|
|
158
|
-
get_sms_campaign = SibApiV3Sdk::GetSmsCampaign.new # GetSmsCampaign | Values to update an SMS Campaign
|
159
|
-
|
160
158
|
|
161
159
|
begin
|
162
160
|
#Get an SMS campaign
|
163
|
-
result = api_instance.get_sms_campaign(campaign_id
|
161
|
+
result = api_instance.get_sms_campaign(campaign_id)
|
164
162
|
p result
|
165
163
|
rescue SibApiV3Sdk::ApiError => e
|
166
164
|
puts "Exception when calling SMSCampaignsApi->get_sms_campaign: #{e}"
|
@@ -172,7 +170,6 @@ end
|
|
172
170
|
Name | Type | Description | Notes
|
173
171
|
------------- | ------------- | ------------- | -------------
|
174
172
|
**campaign_id** | **Integer**| id of the SMS campaign |
|
175
|
-
**get_sms_campaign** | [**GetSmsCampaign**](GetSmsCampaign.md)| Values to update an SMS Campaign |
|
176
173
|
|
177
174
|
### Return type
|
178
175
|
|
data/docs/SMTPApi.md
CHANGED
@@ -215,8 +215,8 @@ end
|
|
215
215
|
api_instance = SibApiV3Sdk::SMTPApi.new
|
216
216
|
|
217
217
|
opts = {
|
218
|
-
start_date:
|
219
|
-
end_date:
|
218
|
+
start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
219
|
+
end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
220
220
|
days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
221
221
|
tag: "tag_example" # String | Tag of the emails
|
222
222
|
}
|
@@ -234,8 +234,8 @@ end
|
|
234
234
|
|
235
235
|
Name | Type | Description | Notes
|
236
236
|
------------- | ------------- | ------------- | -------------
|
237
|
-
**start_date** | **
|
238
|
-
**end_date** | **
|
237
|
+
**start_date** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
|
238
|
+
**end_date** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
|
239
239
|
**days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
|
240
240
|
**tag** | **String**| Tag of the emails | [optional]
|
241
241
|
|
@@ -281,8 +281,8 @@ api_instance = SibApiV3Sdk::SMTPApi.new
|
|
281
281
|
opts = {
|
282
282
|
limit: 50, # Integer | Number limitation for the result returned
|
283
283
|
offset: 0, # Integer | Beginning point in the list to retrieve from.
|
284
|
-
start_date:
|
285
|
-
end_date:
|
284
|
+
start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
285
|
+
end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
286
286
|
days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
287
287
|
email: "email_example", # String | Filter the report for a specific email addresses
|
288
288
|
event: "event_example", # String | Filter the report for a specific event type
|
@@ -306,8 +306,8 @@ Name | Type | Description | Notes
|
|
306
306
|
------------- | ------------- | ------------- | -------------
|
307
307
|
**limit** | **Integer**| Number limitation for the result returned | [optional] [default to 50]
|
308
308
|
**offset** | **Integer**| Beginning point in the list to retrieve from. | [optional] [default to 0]
|
309
|
-
**start_date** | **
|
310
|
-
**end_date** | **
|
309
|
+
**start_date** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
|
310
|
+
**end_date** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
|
311
311
|
**days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
|
312
312
|
**email** | **String**| Filter the report for a specific email addresses | [optional]
|
313
313
|
**event** | **String**| Filter the report for a specific event type | [optional]
|
@@ -357,8 +357,8 @@ api_instance = SibApiV3Sdk::SMTPApi.new
|
|
357
357
|
opts = {
|
358
358
|
limit: 50, # Integer | Number of documents returned per page
|
359
359
|
offset: 0, # Integer | Index of the first document on the page
|
360
|
-
start_date:
|
361
|
-
end_date:
|
360
|
+
start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
|
361
|
+
end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
|
362
362
|
days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
363
363
|
tag: "tag_example" # String | Tag of the emails
|
364
364
|
}
|
@@ -378,8 +378,8 @@ Name | Type | Description | Notes
|
|
378
378
|
------------- | ------------- | ------------- | -------------
|
379
379
|
**limit** | **Integer**| Number of documents returned per page | [optional] [default to 50]
|
380
380
|
**offset** | **Integer**| Index of the first document on the page | [optional] [default to 0]
|
381
|
-
**start_date** | **
|
382
|
-
**end_date** | **
|
381
|
+
**start_date** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) | [optional]
|
382
|
+
**end_date** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional]
|
383
383
|
**days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
|
384
384
|
**tag** | **String**| Tag of the emails | [optional]
|
385
385
|
|
data/docs/TransactionalSMSApi.md
CHANGED
@@ -36,8 +36,8 @@ api_instance = SibApiV3Sdk::TransactionalSMSApi.new
|
|
36
36
|
|
37
37
|
opts = {
|
38
38
|
limit: 50, # Integer | Number of documents per page
|
39
|
-
start_date:
|
40
|
-
end_date:
|
39
|
+
start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
40
|
+
end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
41
41
|
offset: 0, # Integer | Index of the first document of the page
|
42
42
|
days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
43
43
|
phone_number: "phone_number_example", # String | Filter the report for a specific phone number
|
@@ -59,8 +59,8 @@ end
|
|
59
59
|
Name | Type | Description | Notes
|
60
60
|
------------- | ------------- | ------------- | -------------
|
61
61
|
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
62
|
-
**start_date** | **
|
63
|
-
**end_date** | **
|
62
|
+
**start_date** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
|
63
|
+
**end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
|
64
64
|
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
|
65
65
|
**days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
|
66
66
|
**phone_number** | **String**| Filter the report for a specific phone number | [optional]
|
@@ -107,8 +107,8 @@ end
|
|
107
107
|
api_instance = SibApiV3Sdk::TransactionalSMSApi.new
|
108
108
|
|
109
109
|
opts = {
|
110
|
-
start_date:
|
111
|
-
end_date:
|
110
|
+
start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
111
|
+
end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
112
112
|
days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with startDate and endDate
|
113
113
|
tag: "tag_example" # String | Filter on a tag
|
114
114
|
}
|
@@ -126,8 +126,8 @@ end
|
|
126
126
|
|
127
127
|
Name | Type | Description | Notes
|
128
128
|
------------- | ------------- | ------------- | -------------
|
129
|
-
**start_date** | **
|
130
|
-
**end_date** | **
|
129
|
+
**start_date** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
|
130
|
+
**end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
|
131
131
|
**days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with startDate and endDate | [optional]
|
132
132
|
**tag** | **String**| Filter on a tag | [optional]
|
133
133
|
|
@@ -171,8 +171,8 @@ end
|
|
171
171
|
api_instance = SibApiV3Sdk::TransactionalSMSApi.new
|
172
172
|
|
173
173
|
opts = {
|
174
|
-
start_date:
|
175
|
-
end_date:
|
174
|
+
start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
175
|
+
end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
176
176
|
days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
177
177
|
tag: "tag_example" # String | Filter on a tag
|
178
178
|
}
|
@@ -190,8 +190,8 @@ end
|
|
190
190
|
|
191
191
|
Name | Type | Description | Notes
|
192
192
|
------------- | ------------- | ------------- | -------------
|
193
|
-
**start_date** | **
|
194
|
-
**end_date** | **
|
193
|
+
**start_date** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
|
194
|
+
**end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
|
195
195
|
**days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
|
196
196
|
**tag** | **String**| Filter on a tag | [optional]
|
197
197
|
|
@@ -132,21 +132,19 @@ module SibApiV3Sdk
|
|
132
132
|
# Get an SMS campaign
|
133
133
|
#
|
134
134
|
# @param campaign_id id of the SMS campaign
|
135
|
-
# @param get_sms_campaign Values to update an SMS Campaign
|
136
135
|
# @param [Hash] opts the optional parameters
|
137
136
|
# @return [GetSmsCampaign]
|
138
|
-
def get_sms_campaign(campaign_id,
|
139
|
-
data, _status_code, _headers = get_sms_campaign_with_http_info(campaign_id,
|
137
|
+
def get_sms_campaign(campaign_id, opts = {})
|
138
|
+
data, _status_code, _headers = get_sms_campaign_with_http_info(campaign_id, opts)
|
140
139
|
return data
|
141
140
|
end
|
142
141
|
|
143
142
|
# Get an SMS campaign
|
144
143
|
#
|
145
144
|
# @param campaign_id id of the SMS campaign
|
146
|
-
# @param get_sms_campaign Values to update an SMS Campaign
|
147
145
|
# @param [Hash] opts the optional parameters
|
148
146
|
# @return [Array<(GetSmsCampaign, Fixnum, Hash)>] GetSmsCampaign data, response status code and response headers
|
149
|
-
def get_sms_campaign_with_http_info(campaign_id,
|
147
|
+
def get_sms_campaign_with_http_info(campaign_id, opts = {})
|
150
148
|
if @api_client.config.debugging
|
151
149
|
@api_client.config.logger.debug "Calling API: SMSCampaignsApi.get_sms_campaign ..."
|
152
150
|
end
|
@@ -154,10 +152,6 @@ module SibApiV3Sdk
|
|
154
152
|
if @api_client.config.client_side_validation && campaign_id.nil?
|
155
153
|
fail ArgumentError, "Missing the required parameter 'campaign_id' when calling SMSCampaignsApi.get_sms_campaign"
|
156
154
|
end
|
157
|
-
# verify the required parameter 'get_sms_campaign' is set
|
158
|
-
if @api_client.config.client_side_validation && get_sms_campaign.nil?
|
159
|
-
fail ArgumentError, "Missing the required parameter 'get_sms_campaign' when calling SMSCampaignsApi.get_sms_campaign"
|
160
|
-
end
|
161
155
|
# resource path
|
162
156
|
local_var_path = "/smsCampaigns/{campaignId}".sub('{' + 'campaignId' + '}', campaign_id.to_s)
|
163
157
|
|
@@ -175,7 +169,7 @@ module SibApiV3Sdk
|
|
175
169
|
form_params = {}
|
176
170
|
|
177
171
|
# http body (model)
|
178
|
-
post_body =
|
172
|
+
post_body = nil
|
179
173
|
auth_names = ['api-key', 'partner-key']
|
180
174
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
181
175
|
:header_params => header_params,
|
@@ -182,8 +182,8 @@ module SibApiV3Sdk
|
|
182
182
|
# Get your SMTP activity aggregated over a period of time
|
183
183
|
#
|
184
184
|
# @param [Hash] opts the optional parameters
|
185
|
-
# @option opts [
|
186
|
-
# @option opts [
|
185
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
186
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
187
187
|
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
188
188
|
# @option opts [String] :tag Tag of the emails
|
189
189
|
# @return [GetAggregatedReport]
|
@@ -195,8 +195,8 @@ module SibApiV3Sdk
|
|
195
195
|
# Get your SMTP activity aggregated over a period of time
|
196
196
|
#
|
197
197
|
# @param [Hash] opts the optional parameters
|
198
|
-
# @option opts [
|
199
|
-
# @option opts [
|
198
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
199
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
200
200
|
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
201
201
|
# @option opts [String] :tag Tag of the emails
|
202
202
|
# @return [Array<(GetAggregatedReport, Fixnum, Hash)>] GetAggregatedReport data, response status code and response headers
|
@@ -245,8 +245,8 @@ module SibApiV3Sdk
|
|
245
245
|
# @param [Hash] opts the optional parameters
|
246
246
|
# @option opts [Integer] :limit Number limitation for the result returned (default to 50)
|
247
247
|
# @option opts [Integer] :offset Beginning point in the list to retrieve from. (default to 0)
|
248
|
-
# @option opts [
|
249
|
-
# @option opts [
|
248
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
249
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
250
250
|
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
251
251
|
# @option opts [String] :email Filter the report for a specific email addresses
|
252
252
|
# @option opts [String] :event Filter the report for a specific event type
|
@@ -264,8 +264,8 @@ module SibApiV3Sdk
|
|
264
264
|
# @param [Hash] opts the optional parameters
|
265
265
|
# @option opts [Integer] :limit Number limitation for the result returned
|
266
266
|
# @option opts [Integer] :offset Beginning point in the list to retrieve from.
|
267
|
-
# @option opts [
|
268
|
-
# @option opts [
|
267
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
268
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
269
269
|
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
270
270
|
# @option opts [String] :email Filter the report for a specific email addresses
|
271
271
|
# @option opts [String] :event Filter the report for a specific event type
|
@@ -331,8 +331,8 @@ module SibApiV3Sdk
|
|
331
331
|
# @param [Hash] opts the optional parameters
|
332
332
|
# @option opts [Integer] :limit Number of documents returned per page (default to 50)
|
333
333
|
# @option opts [Integer] :offset Index of the first document on the page (default to 0)
|
334
|
-
# @option opts [
|
335
|
-
# @option opts [
|
334
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
|
335
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
|
336
336
|
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
337
337
|
# @option opts [String] :tag Tag of the emails
|
338
338
|
# @return [GetReports]
|
@@ -346,8 +346,8 @@ module SibApiV3Sdk
|
|
346
346
|
# @param [Hash] opts the optional parameters
|
347
347
|
# @option opts [Integer] :limit Number of documents returned per page
|
348
348
|
# @option opts [Integer] :offset Index of the first document on the page
|
349
|
-
# @option opts [
|
350
|
-
# @option opts [
|
349
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
|
350
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
|
351
351
|
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
352
352
|
# @option opts [String] :tag Tag of the emails
|
353
353
|
# @return [Array<(GetReports, Fixnum, Hash)>] GetReports data, response status code and response headers
|
@@ -24,8 +24,8 @@ module SibApiV3Sdk
|
|
24
24
|
#
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @option opts [Integer] :limit Number of documents per page (default to 50)
|
27
|
-
# @option opts [
|
28
|
-
# @option opts [
|
27
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
28
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
29
29
|
# @option opts [Integer] :offset Index of the first document of the page (default to 0)
|
30
30
|
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
31
31
|
# @option opts [String] :phone_number Filter the report for a specific phone number
|
@@ -41,8 +41,8 @@ module SibApiV3Sdk
|
|
41
41
|
#
|
42
42
|
# @param [Hash] opts the optional parameters
|
43
43
|
# @option opts [Integer] :limit Number of documents per page
|
44
|
-
# @option opts [
|
45
|
-
# @option opts [
|
44
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
45
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
46
46
|
# @option opts [Integer] :offset Index of the first document of the page
|
47
47
|
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
48
48
|
# @option opts [String] :phone_number Filter the report for a specific phone number
|
@@ -103,8 +103,8 @@ module SibApiV3Sdk
|
|
103
103
|
# Get your SMS activity aggregated over a period of time
|
104
104
|
#
|
105
105
|
# @param [Hash] opts the optional parameters
|
106
|
-
# @option opts [
|
107
|
-
# @option opts [
|
106
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
107
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
108
108
|
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with startDate and endDate
|
109
109
|
# @option opts [String] :tag Filter on a tag
|
110
110
|
# @return [GetTransacAggregatedSmsReport]
|
@@ -116,8 +116,8 @@ module SibApiV3Sdk
|
|
116
116
|
# Get your SMS activity aggregated over a period of time
|
117
117
|
#
|
118
118
|
# @param [Hash] opts the optional parameters
|
119
|
-
# @option opts [
|
120
|
-
# @option opts [
|
119
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
120
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
121
121
|
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with startDate and endDate
|
122
122
|
# @option opts [String] :tag Filter on a tag
|
123
123
|
# @return [Array<(GetTransacAggregatedSmsReport, Fixnum, Hash)>] GetTransacAggregatedSmsReport data, response status code and response headers
|
@@ -164,8 +164,8 @@ module SibApiV3Sdk
|
|
164
164
|
# Get your SMS activity aggregated per day
|
165
165
|
#
|
166
166
|
# @param [Hash] opts the optional parameters
|
167
|
-
# @option opts [
|
168
|
-
# @option opts [
|
167
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
168
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
169
169
|
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
170
170
|
# @option opts [String] :tag Filter on a tag
|
171
171
|
# @return [GetTransacSmsReport]
|
@@ -177,8 +177,8 @@ module SibApiV3Sdk
|
|
177
177
|
# Get your SMS activity aggregated per day
|
178
178
|
#
|
179
179
|
# @param [Hash] opts the optional parameters
|
180
|
-
# @option opts [
|
181
|
-
# @option opts [
|
180
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
181
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
182
182
|
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
183
183
|
# @option opts [String] :tag Filter on a tag
|
184
184
|
# @return [Array<(GetTransacSmsReport, Fixnum, Hash)>] GetTransacSmsReport data, response status code and response headers
|
@@ -128,7 +128,7 @@ module SibApiV3Sdk
|
|
128
128
|
return false if @category.nil?
|
129
129
|
category_validator = EnumAttributeValidator.new('String', ["normal", "transactional", "category", "calculated", "global"])
|
130
130
|
return false unless category_validator.valid?(@category)
|
131
|
-
type_validator = EnumAttributeValidator.new('String', ["text", "date", "float", "id"])
|
131
|
+
type_validator = EnumAttributeValidator.new('String', ["text", "date", "float", "id", "boolean"])
|
132
132
|
return false unless type_validator.valid?(@type)
|
133
133
|
return true
|
134
134
|
end
|
@@ -146,7 +146,7 @@ module SibApiV3Sdk
|
|
146
146
|
# Custom attribute writer method checking allowed values (enum).
|
147
147
|
# @param [Object] type Object to be assigned
|
148
148
|
def type=(type)
|
149
|
-
validator = EnumAttributeValidator.new('String', ["text", "date", "float", "id"])
|
149
|
+
validator = EnumAttributeValidator.new('String', ["text", "date", "float", "id", "boolean"])
|
150
150
|
unless validator.valid?(type)
|
151
151
|
fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
|
152
152
|
end
|
@@ -60,7 +60,6 @@ describe 'SMSCampaignsApi' do
|
|
60
60
|
# Get an SMS campaign
|
61
61
|
#
|
62
62
|
# @param campaign_id id of the SMS campaign
|
63
|
-
# @param get_sms_campaign Values to update an SMS Campaign
|
64
63
|
# @param [Hash] opts the optional parameters
|
65
64
|
# @return [GetSmsCampaign]
|
66
65
|
describe 'get_sms_campaign test' do
|
data/spec/api/smtp_api_spec.rb
CHANGED
@@ -72,8 +72,8 @@ describe 'SMTPApi' do
|
|
72
72
|
# Get your SMTP activity aggregated over a period of time
|
73
73
|
#
|
74
74
|
# @param [Hash] opts the optional parameters
|
75
|
-
# @option opts [
|
76
|
-
# @option opts [
|
75
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
76
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
77
77
|
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
78
78
|
# @option opts [String] :tag Tag of the emails
|
79
79
|
# @return [GetAggregatedReport]
|
@@ -89,8 +89,8 @@ describe 'SMTPApi' do
|
|
89
89
|
# @param [Hash] opts the optional parameters
|
90
90
|
# @option opts [Integer] :limit Number limitation for the result returned
|
91
91
|
# @option opts [Integer] :offset Beginning point in the list to retrieve from.
|
92
|
-
# @option opts [
|
93
|
-
# @option opts [
|
92
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
|
93
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
|
94
94
|
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
95
95
|
# @option opts [String] :email Filter the report for a specific email addresses
|
96
96
|
# @option opts [String] :event Filter the report for a specific event type
|
@@ -110,8 +110,8 @@ describe 'SMTPApi' do
|
|
110
110
|
# @param [Hash] opts the optional parameters
|
111
111
|
# @option opts [Integer] :limit Number of documents returned per page
|
112
112
|
# @option opts [Integer] :offset Index of the first document on the page
|
113
|
-
# @option opts [
|
114
|
-
# @option opts [
|
113
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
|
114
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
|
115
115
|
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
116
116
|
# @option opts [String] :tag Tag of the emails
|
117
117
|
# @return [GetReports]
|
@@ -37,8 +37,8 @@ describe 'TransactionalSMSApi' do
|
|
37
37
|
#
|
38
38
|
# @param [Hash] opts the optional parameters
|
39
39
|
# @option opts [Integer] :limit Number of documents per page
|
40
|
-
# @option opts [
|
41
|
-
# @option opts [
|
40
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
41
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
42
42
|
# @option opts [Integer] :offset Index of the first document of the page
|
43
43
|
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
44
44
|
# @option opts [String] :phone_number Filter the report for a specific phone number
|
@@ -55,8 +55,8 @@ describe 'TransactionalSMSApi' do
|
|
55
55
|
# Get your SMS activity aggregated over a period of time
|
56
56
|
#
|
57
57
|
# @param [Hash] opts the optional parameters
|
58
|
-
# @option opts [
|
59
|
-
# @option opts [
|
58
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
59
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
60
60
|
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with startDate and endDate
|
61
61
|
# @option opts [String] :tag Filter on a tag
|
62
62
|
# @return [GetTransacAggregatedSmsReport]
|
@@ -70,8 +70,8 @@ describe 'TransactionalSMSApi' do
|
|
70
70
|
# Get your SMS activity aggregated per day
|
71
71
|
#
|
72
72
|
# @param [Hash] opts the optional parameters
|
73
|
-
# @option opts [
|
74
|
-
# @option opts [
|
73
|
+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
|
74
|
+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
|
75
75
|
# @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
|
76
76
|
# @option opts [String] :tag Filter on a tag
|
77
77
|
# @return [GetTransacSmsReport]
|
@@ -51,7 +51,7 @@ describe 'GetAttributesAttributes' do
|
|
51
51
|
describe 'test attribute "type"' do
|
52
52
|
it 'should work' do
|
53
53
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
54
|
-
#validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["text", "date", "float", "id"])
|
54
|
+
#validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["text", "date", "float", "id", "boolean"])
|
55
55
|
#validator.allowable_values.each do |value|
|
56
56
|
# expect { @instance.type = value }.not_to raise_error
|
57
57
|
#end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: sib-api-v3-sdk
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 5.2.
|
4
|
+
version: 5.2.2
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- SendinBlue Developers
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2019-03-
|
11
|
+
date: 2019-03-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|