sib-api-v3-sdk 5.1.1 → 5.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/docs/CreateEmailCampaign.md +1 -1
- data/docs/CreateSmsCampaign.md +1 -1
- data/docs/CreateSmsCampaignRecipients.md +1 -1
- data/docs/GetAggregatedReport.md +1 -0
- data/docs/GetReportsReports.md +1 -0
- data/docs/GetSmsCampaign.md +0 -1
- data/docs/GetSmsCampaignOverview.md +0 -1
- data/docs/SMSCampaignsApi.md +4 -0
- data/docs/SendEmail.md +1 -1
- data/docs/SendSmtpEmail.md +2 -2
- data/docs/SendTransacSms.md +1 -1
- data/docs/UpdateEmailCampaign.md +1 -1
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +8 -2
- data/lib/sib-api-v3-sdk/api/smtp_api.rb +2 -2
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +1 -1
- data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +5 -0
- data/lib/sib-api-v3-sdk/models/create_sms_campaign_recipients.rb +0 -5
- data/lib/sib-api-v3-sdk/models/get_aggregated_report.rb +19 -4
- data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +2 -2
- data/lib/sib-api-v3-sdk/models/get_reports_reports.rb +19 -4
- data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +3 -18
- data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +3 -18
- data/lib/sib-api-v3-sdk/models/send_email.rb +1 -1
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +2 -2
- data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +1 -1
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +1 -1
- data/lib/sib-api-v3-sdk/version.rb +1 -1
- data/spec/api/sms_campaigns_api_spec.rb +2 -0
- data/spec/models/get_aggregated_report_spec.rb +6 -0
- data/spec/models/get_email_event_report_events_spec.rb +1 -1
- data/spec/models/get_reports_reports_spec.rb +6 -0
- data/spec/models/get_sms_campaign_overview_spec.rb +1 -7
- data/spec/models/get_sms_campaign_spec.rb +1 -7
- 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: 6201afb8a72d6f8cc9904435e63e6f3d8633b7780df239cb5ddc1efd49d40824
|
4
|
+
data.tar.gz: a65001ba3b16ca4de53d3d56ee0b42fa5c5d6eb034f1482032461445e04ddccb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 266f37294661ade35aec25fd5cfb628b16a54174cb56711e5a78d4150375650b3174f555a42e37111b12bd1e39c4b9e45d0386348572a334233f91aacda09158
|
7
|
+
data.tar.gz: 406359d15ead75f4f4c4d4234ec08cf52a4026a8f1bf33f94699abe66cd516536e38875017d03b738990a134e8cd8e00eb8b23b2a8bfd95af33775fa02bb0d78
|
data/docs/CreateEmailCampaign.md
CHANGED
@@ -22,6 +22,6 @@ Name | Type | Description | Notes
|
|
22
22
|
**footer** | **String** | Footer of the email campaign | [optional]
|
23
23
|
**header** | **String** | Header of the email campaign | [optional]
|
24
24
|
**utm_campaign** | **String** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional]
|
25
|
-
**params** | **Object** | Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic' | [optional]
|
25
|
+
**params** | **Object** | Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional]
|
26
26
|
|
27
27
|
|
data/docs/CreateSmsCampaign.md
CHANGED
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**name** | **String** | Name of the campaign |
|
7
7
|
**sender** | **String** | Name of the sender. The number of characters is limited to 11 |
|
8
|
-
**content** | **String** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS |
|
8
|
+
**content** | **String** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS |
|
9
9
|
**recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional]
|
10
10
|
**scheduled_at** | **DateTime** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
11
11
|
|
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**list_ids** | **Array<Integer>** | Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty |
|
7
|
-
**exclusion_list_ids** | **Array<Integer>** | List ids which have to be excluded from a campaign |
|
7
|
+
**exclusion_list_ids** | **Array<Integer>** | List ids which have to be excluded from a campaign | [optional]
|
8
8
|
|
9
9
|
|
data/docs/GetAggregatedReport.md
CHANGED
@@ -15,5 +15,6 @@ Name | Type | Description | Notes
|
|
15
15
|
**spam_reports** | **Integer** | Number of complaint (spam report) for the timeframe |
|
16
16
|
**blocked** | **Integer** | Number of blocked contact emails for the timeframe |
|
17
17
|
**invalid** | **Integer** | Number of invalid emails for the timeframe |
|
18
|
+
**unsubscribed** | **Integer** | Number of unsubscribed emails for the timeframe |
|
18
19
|
|
19
20
|
|
data/docs/GetReportsReports.md
CHANGED
@@ -15,5 +15,6 @@ Name | Type | Description | Notes
|
|
15
15
|
**spam_reports** | **Integer** | Number of complaints (spam reports) for the date |
|
16
16
|
**blocked** | **Integer** | Number of blocked emails for the date |
|
17
17
|
**invalid** | **Integer** | Number of invalid emails for the date |
|
18
|
+
**unsubscribed** | **Integer** | Number of unsubscribed emails for the date |
|
18
19
|
|
19
20
|
|
data/docs/GetSmsCampaign.md
CHANGED
@@ -8,7 +8,6 @@ Name | Type | Description | Notes
|
|
8
8
|
**status** | **String** | Status of the SMS Campaign |
|
9
9
|
**content** | **String** | Content of the SMS Campaign |
|
10
10
|
**scheduled_at** | **DateTime** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
|
11
|
-
**test_sent** | **BOOLEAN** | Retrieved the status of test SMS sending. (true=Test SMS has been sent false=Test SMS has not been sent) |
|
12
11
|
**sender** | **String** | Sender of the SMS Campaign |
|
13
12
|
**created_at** | **DateTime** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
14
13
|
**modified_at** | **DateTime** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
@@ -8,7 +8,6 @@ Name | Type | Description | Notes
|
|
8
8
|
**status** | **String** | Status of the SMS Campaign |
|
9
9
|
**content** | **String** | Content of the SMS Campaign |
|
10
10
|
**scheduled_at** | **DateTime** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
|
11
|
-
**test_sent** | **BOOLEAN** | Retrieved the status of test SMS sending. (true=Test SMS has been sent false=Test SMS has not been sent) |
|
12
11
|
**sender** | **String** | Sender of the SMS Campaign |
|
13
12
|
**created_at** | **DateTime** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
14
13
|
**modified_at** | **DateTime** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
data/docs/SMSCampaignsApi.md
CHANGED
@@ -195,6 +195,8 @@ api_instance = SibApiV3Sdk::SMSCampaignsApi.new
|
|
195
195
|
|
196
196
|
opts = {
|
197
197
|
status: "status_example", # String | Status of campaign.
|
198
|
+
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 sms 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' )
|
199
|
+
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 sms 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' )
|
198
200
|
limit: 500, # Integer | Number limitation for the result returned
|
199
201
|
offset: 0 # Integer | Beginning point in the list to retrieve from.
|
200
202
|
}
|
@@ -213,6 +215,8 @@ end
|
|
213
215
|
Name | Type | Description | Notes
|
214
216
|
------------- | ------------- | ------------- | -------------
|
215
217
|
**status** | **String**| Status of campaign. | [optional]
|
218
|
+
**start_date** | **DateTime**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms 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]
|
219
|
+
**end_date** | **DateTime**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms 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]
|
216
220
|
**limit** | **Integer**| Number limitation for the result returned | [optional] [default to 500]
|
217
221
|
**offset** | **Integer**| Beginning point in the list to retrieve from. | [optional] [default to 0]
|
218
222
|
|
data/docs/SendEmail.md
CHANGED
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**reply_to** | **String** | Email address which shall be used by campaign recipients to reply back | [optional]
|
10
10
|
**attachment_url** | **String** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional]
|
11
11
|
**attachment** | [**Array<SendEmailAttachment>**](SendEmailAttachment.md) | Pass the list of content (base64 encoded) and name of the attachment. For example, [{'content':'base64 encoded content 1', 'name':'attcahment1'}, {'content':'base64 encoded content 2', 'name':'attcahment2'}]. | [optional]
|
12
|
-
**headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. '
|
12
|
+
**headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'} | [optional]
|
13
13
|
**attributes** | **Object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'} | [optional]
|
14
14
|
**tags** | **Array<String>** | Tag your emails to find them more easily | [optional]
|
15
15
|
|
data/docs/SendSmtpEmail.md
CHANGED
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
|
|
12
12
|
**subject** | **String** | Subject of the message. Mandatory if 'templateId' is not passed | [optional]
|
13
13
|
**reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
|
14
14
|
**attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, [{'url':'https://attachment.domain.com/myAttachmentFromUrl.jpg', 'name':'My attachment 1'}, {'content':'base64 exmaple content', 'name':'My attachment 2'}]. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps ( Ignored if 'templateId' is passed ) | [optional]
|
15
|
-
**headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. '
|
15
|
+
**headers** | **Object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'} | [optional]
|
16
16
|
**template_id** | **Integer** | Id of the template | [optional]
|
17
|
-
**params** | **Object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. | [optional]
|
17
|
+
**params** | **Object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. It's considered only if template is in New Template Language format. | [optional]
|
18
18
|
**tags** | **Array<String>** | Tag your emails to find them more easily | [optional]
|
19
19
|
|
20
20
|
|
data/docs/SendTransacSms.md
CHANGED
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
**sender** | **String** | Name of the sender. Only alphanumeric characters. No more than 11 characters |
|
7
7
|
**recipient** | **String** | Mobile number to send SMS with the country code |
|
8
8
|
**content** | **String** | Content of the message. If more than 160 characters long, will be sent as multiple text messages |
|
9
|
-
**type** | **String** | Type of the SMS | [optional] [default to "transactional"]
|
9
|
+
**type** | **String** | Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. | [optional] [default to "transactional"]
|
10
10
|
**tag** | **String** | Tag of the message | [optional]
|
11
11
|
**web_url** | **String** | Webhook to call for each event triggered by the message (delivered etc.) | [optional]
|
12
12
|
|
data/docs/UpdateEmailCampaign.md
CHANGED
@@ -20,6 +20,6 @@ Name | Type | Description | Notes
|
|
20
20
|
**footer** | **String** | Footer of the email campaign | [optional]
|
21
21
|
**header** | **String** | Header of the email campaign | [optional]
|
22
22
|
**utm_campaign** | **String** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional]
|
23
|
-
**params** | **Object** | Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. | [optional]
|
23
|
+
**params** | **Object** | Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional]
|
24
24
|
|
25
25
|
|
@@ -194,6 +194,8 @@ module SibApiV3Sdk
|
|
194
194
|
#
|
195
195
|
# @param [Hash] opts the optional parameters
|
196
196
|
# @option opts [String] :status Status of campaign.
|
197
|
+
# @option opts [DateTime] :start_date Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms 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' )
|
198
|
+
# @option opts [DateTime] :end_date Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms 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' )
|
197
199
|
# @option opts [Integer] :limit Number limitation for the result returned (default to 500)
|
198
200
|
# @option opts [Integer] :offset Beginning point in the list to retrieve from. (default to 0)
|
199
201
|
# @return [GetSmsCampaigns]
|
@@ -206,6 +208,8 @@ module SibApiV3Sdk
|
|
206
208
|
#
|
207
209
|
# @param [Hash] opts the optional parameters
|
208
210
|
# @option opts [String] :status Status of campaign.
|
211
|
+
# @option opts [DateTime] :start_date Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms 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' )
|
212
|
+
# @option opts [DateTime] :end_date Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms 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' )
|
209
213
|
# @option opts [Integer] :limit Number limitation for the result returned
|
210
214
|
# @option opts [Integer] :offset Beginning point in the list to retrieve from.
|
211
215
|
# @return [Array<(GetSmsCampaigns, Fixnum, Hash)>] GetSmsCampaigns data, response status code and response headers
|
@@ -213,8 +217,8 @@ module SibApiV3Sdk
|
|
213
217
|
if @api_client.config.debugging
|
214
218
|
@api_client.config.logger.debug "Calling API: SMSCampaignsApi.get_sms_campaigns ..."
|
215
219
|
end
|
216
|
-
if @api_client.config.client_side_validation && opts[:'status'] && !['suspended', '
|
217
|
-
fail ArgumentError, 'invalid value for "status", must be one of suspended,
|
220
|
+
if @api_client.config.client_side_validation && opts[:'status'] && !['suspended', 'archive', 'sent', 'queued', 'draft', 'inProcess'].include?(opts[:'status'])
|
221
|
+
fail ArgumentError, 'invalid value for "status", must be one of suspended, archive, sent, queued, draft, inProcess'
|
218
222
|
end
|
219
223
|
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
|
220
224
|
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SMSCampaignsApi.get_sms_campaigns, must be smaller than or equal to 1000.'
|
@@ -226,6 +230,8 @@ module SibApiV3Sdk
|
|
226
230
|
# query parameters
|
227
231
|
query_params = {}
|
228
232
|
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
233
|
+
query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
234
|
+
query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
229
235
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
230
236
|
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
231
237
|
|
@@ -281,8 +281,8 @@ module SibApiV3Sdk
|
|
281
281
|
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SMTPApi.get_email_event_report, must be smaller than or equal to 100.'
|
282
282
|
end
|
283
283
|
|
284
|
-
if @api_client.config.client_side_validation && opts[:'event'] && !['bounces', 'hardBounces', 'softBounces', 'delivered', 'spam', 'requests', 'opened', 'clicks', 'invalid', 'deferred', 'blocked'].include?(opts[:'event'])
|
285
|
-
fail ArgumentError, 'invalid value for "event", must be one of bounces, hardBounces, softBounces, delivered, spam, requests, opened, clicks, invalid, deferred, blocked'
|
284
|
+
if @api_client.config.client_side_validation && opts[:'event'] && !['bounces', 'hardBounces', 'softBounces', 'delivered', 'spam', 'requests', 'opened', 'clicks', 'invalid', 'deferred', 'blocked', 'unsubscribed'].include?(opts[:'event'])
|
285
|
+
fail ArgumentError, 'invalid value for "event", must be one of bounces, hardBounces, softBounces, delivered, spam, requests, opened, clicks, invalid, deferred, blocked, unsubscribed'
|
286
286
|
end
|
287
287
|
# resource path
|
288
288
|
local_var_path = "/smtp/statistics/events"
|
@@ -70,7 +70,7 @@ module SibApiV3Sdk
|
|
70
70
|
# Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed
|
71
71
|
attr_accessor :utm_campaign
|
72
72
|
|
73
|
-
# Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic'
|
73
|
+
# Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField'
|
74
74
|
attr_accessor :params
|
75
75
|
|
76
76
|
class EnumAttributeValidator
|
@@ -98,6 +98,10 @@ module SibApiV3Sdk
|
|
98
98
|
invalid_properties.push("invalid value for 'sender', the character length must be smaller than or equal to 11.")
|
99
99
|
end
|
100
100
|
|
101
|
+
if @content.nil?
|
102
|
+
invalid_properties.push("invalid value for 'content', content cannot be nil.")
|
103
|
+
end
|
104
|
+
|
101
105
|
return invalid_properties
|
102
106
|
end
|
103
107
|
|
@@ -107,6 +111,7 @@ module SibApiV3Sdk
|
|
107
111
|
return false if @name.nil?
|
108
112
|
return false if @sender.nil?
|
109
113
|
return false if @sender.to_s.length > 11
|
114
|
+
return false if @content.nil?
|
110
115
|
return true
|
111
116
|
end
|
112
117
|
|
@@ -68,10 +68,6 @@ module SibApiV3Sdk
|
|
68
68
|
invalid_properties.push("invalid value for 'list_ids', list_ids cannot be nil.")
|
69
69
|
end
|
70
70
|
|
71
|
-
if @exclusion_list_ids.nil?
|
72
|
-
invalid_properties.push("invalid value for 'exclusion_list_ids', exclusion_list_ids cannot be nil.")
|
73
|
-
end
|
74
|
-
|
75
71
|
return invalid_properties
|
76
72
|
end
|
77
73
|
|
@@ -79,7 +75,6 @@ module SibApiV3Sdk
|
|
79
75
|
# @return true if the model is valid
|
80
76
|
def valid?
|
81
77
|
return false if @list_ids.nil?
|
82
|
-
return false if @exclusion_list_ids.nil?
|
83
78
|
return true
|
84
79
|
end
|
85
80
|
|
@@ -51,6 +51,9 @@ module SibApiV3Sdk
|
|
51
51
|
# Number of invalid emails for the timeframe
|
52
52
|
attr_accessor :invalid
|
53
53
|
|
54
|
+
# Number of unsubscribed emails for the timeframe
|
55
|
+
attr_accessor :unsubscribed
|
56
|
+
|
54
57
|
|
55
58
|
# Attribute mapping from ruby-style variable name to JSON key.
|
56
59
|
def self.attribute_map
|
@@ -66,7 +69,8 @@ module SibApiV3Sdk
|
|
66
69
|
:'unique_opens' => :'uniqueOpens',
|
67
70
|
:'spam_reports' => :'spamReports',
|
68
71
|
:'blocked' => :'blocked',
|
69
|
-
:'invalid' => :'invalid'
|
72
|
+
:'invalid' => :'invalid',
|
73
|
+
:'unsubscribed' => :'unsubscribed'
|
70
74
|
}
|
71
75
|
end
|
72
76
|
|
@@ -84,7 +88,8 @@ module SibApiV3Sdk
|
|
84
88
|
:'unique_opens' => :'Integer',
|
85
89
|
:'spam_reports' => :'Integer',
|
86
90
|
:'blocked' => :'Integer',
|
87
|
-
:'invalid' => :'Integer'
|
91
|
+
:'invalid' => :'Integer',
|
92
|
+
:'unsubscribed' => :'Integer'
|
88
93
|
}
|
89
94
|
end
|
90
95
|
|
@@ -144,6 +149,10 @@ module SibApiV3Sdk
|
|
144
149
|
self.invalid = attributes[:'invalid']
|
145
150
|
end
|
146
151
|
|
152
|
+
if attributes.has_key?(:'unsubscribed')
|
153
|
+
self.unsubscribed = attributes[:'unsubscribed']
|
154
|
+
end
|
155
|
+
|
147
156
|
end
|
148
157
|
|
149
158
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -198,6 +207,10 @@ module SibApiV3Sdk
|
|
198
207
|
invalid_properties.push("invalid value for 'invalid', invalid cannot be nil.")
|
199
208
|
end
|
200
209
|
|
210
|
+
if @unsubscribed.nil?
|
211
|
+
invalid_properties.push("invalid value for 'unsubscribed', unsubscribed cannot be nil.")
|
212
|
+
end
|
213
|
+
|
201
214
|
return invalid_properties
|
202
215
|
end
|
203
216
|
|
@@ -216,6 +229,7 @@ module SibApiV3Sdk
|
|
216
229
|
return false if @spam_reports.nil?
|
217
230
|
return false if @blocked.nil?
|
218
231
|
return false if @invalid.nil?
|
232
|
+
return false if @unsubscribed.nil?
|
219
233
|
return true
|
220
234
|
end
|
221
235
|
|
@@ -235,7 +249,8 @@ module SibApiV3Sdk
|
|
235
249
|
unique_opens == o.unique_opens &&
|
236
250
|
spam_reports == o.spam_reports &&
|
237
251
|
blocked == o.blocked &&
|
238
|
-
invalid == o.invalid
|
252
|
+
invalid == o.invalid &&
|
253
|
+
unsubscribed == o.unsubscribed
|
239
254
|
end
|
240
255
|
|
241
256
|
# @see the `==` method
|
@@ -247,7 +262,7 @@ module SibApiV3Sdk
|
|
247
262
|
# Calculates hash code according to all attributes.
|
248
263
|
# @return [Fixnum] Hash code
|
249
264
|
def hash
|
250
|
-
[range, requests, delivered, hard_bounces, soft_bounces, clicks, unique_clicks, opens, unique_opens, spam_reports, blocked, invalid].hash
|
265
|
+
[range, requests, delivered, hard_bounces, soft_bounces, clicks, unique_clicks, opens, unique_opens, spam_reports, blocked, invalid, unsubscribed].hash
|
251
266
|
end
|
252
267
|
|
253
268
|
# Builds the object from hash
|
@@ -179,7 +179,7 @@ module SibApiV3Sdk
|
|
179
179
|
return false if @date.nil?
|
180
180
|
return false if @message_id.nil?
|
181
181
|
return false if @event.nil?
|
182
|
-
event_validator = EnumAttributeValidator.new('String', ["bounces", "hardBounces", "softBounces", "delivered", "spam", "requests", "opened", "clicks", "invalid", "deferred", "blocked"])
|
182
|
+
event_validator = EnumAttributeValidator.new('String', ["bounces", "hardBounces", "softBounces", "delivered", "spam", "requests", "opened", "clicks", "invalid", "deferred", "blocked", "unsubscribed"])
|
183
183
|
return false unless event_validator.valid?(@event)
|
184
184
|
return true
|
185
185
|
end
|
@@ -187,7 +187,7 @@ module SibApiV3Sdk
|
|
187
187
|
# Custom attribute writer method checking allowed values (enum).
|
188
188
|
# @param [Object] event Object to be assigned
|
189
189
|
def event=(event)
|
190
|
-
validator = EnumAttributeValidator.new('String', ["bounces", "hardBounces", "softBounces", "delivered", "spam", "requests", "opened", "clicks", "invalid", "deferred", "blocked"])
|
190
|
+
validator = EnumAttributeValidator.new('String', ["bounces", "hardBounces", "softBounces", "delivered", "spam", "requests", "opened", "clicks", "invalid", "deferred", "blocked", "unsubscribed"])
|
191
191
|
unless validator.valid?(event)
|
192
192
|
fail ArgumentError, "invalid value for 'event', must be one of #{validator.allowable_values}."
|
193
193
|
end
|
@@ -51,6 +51,9 @@ module SibApiV3Sdk
|
|
51
51
|
# Number of invalid emails for the date
|
52
52
|
attr_accessor :invalid
|
53
53
|
|
54
|
+
# Number of unsubscribed emails for the date
|
55
|
+
attr_accessor :unsubscribed
|
56
|
+
|
54
57
|
|
55
58
|
# Attribute mapping from ruby-style variable name to JSON key.
|
56
59
|
def self.attribute_map
|
@@ -66,7 +69,8 @@ module SibApiV3Sdk
|
|
66
69
|
:'unique_opens' => :'uniqueOpens',
|
67
70
|
:'spam_reports' => :'spamReports',
|
68
71
|
:'blocked' => :'blocked',
|
69
|
-
:'invalid' => :'invalid'
|
72
|
+
:'invalid' => :'invalid',
|
73
|
+
:'unsubscribed' => :'unsubscribed'
|
70
74
|
}
|
71
75
|
end
|
72
76
|
|
@@ -84,7 +88,8 @@ module SibApiV3Sdk
|
|
84
88
|
:'unique_opens' => :'Integer',
|
85
89
|
:'spam_reports' => :'Integer',
|
86
90
|
:'blocked' => :'Integer',
|
87
|
-
:'invalid' => :'Integer'
|
91
|
+
:'invalid' => :'Integer',
|
92
|
+
:'unsubscribed' => :'Integer'
|
88
93
|
}
|
89
94
|
end
|
90
95
|
|
@@ -144,6 +149,10 @@ module SibApiV3Sdk
|
|
144
149
|
self.invalid = attributes[:'invalid']
|
145
150
|
end
|
146
151
|
|
152
|
+
if attributes.has_key?(:'unsubscribed')
|
153
|
+
self.unsubscribed = attributes[:'unsubscribed']
|
154
|
+
end
|
155
|
+
|
147
156
|
end
|
148
157
|
|
149
158
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -198,6 +207,10 @@ module SibApiV3Sdk
|
|
198
207
|
invalid_properties.push("invalid value for 'invalid', invalid cannot be nil.")
|
199
208
|
end
|
200
209
|
|
210
|
+
if @unsubscribed.nil?
|
211
|
+
invalid_properties.push("invalid value for 'unsubscribed', unsubscribed cannot be nil.")
|
212
|
+
end
|
213
|
+
|
201
214
|
return invalid_properties
|
202
215
|
end
|
203
216
|
|
@@ -216,6 +229,7 @@ module SibApiV3Sdk
|
|
216
229
|
return false if @spam_reports.nil?
|
217
230
|
return false if @blocked.nil?
|
218
231
|
return false if @invalid.nil?
|
232
|
+
return false if @unsubscribed.nil?
|
219
233
|
return true
|
220
234
|
end
|
221
235
|
|
@@ -235,7 +249,8 @@ module SibApiV3Sdk
|
|
235
249
|
unique_opens == o.unique_opens &&
|
236
250
|
spam_reports == o.spam_reports &&
|
237
251
|
blocked == o.blocked &&
|
238
|
-
invalid == o.invalid
|
252
|
+
invalid == o.invalid &&
|
253
|
+
unsubscribed == o.unsubscribed
|
239
254
|
end
|
240
255
|
|
241
256
|
# @see the `==` method
|
@@ -247,7 +262,7 @@ module SibApiV3Sdk
|
|
247
262
|
# Calculates hash code according to all attributes.
|
248
263
|
# @return [Fixnum] Hash code
|
249
264
|
def hash
|
250
|
-
[date, requests, delivered, hard_bounces, soft_bounces, clicks, unique_clicks, opens, unique_opens, spam_reports, blocked, invalid].hash
|
265
|
+
[date, requests, delivered, hard_bounces, soft_bounces, clicks, unique_clicks, opens, unique_opens, spam_reports, blocked, invalid, unsubscribed].hash
|
251
266
|
end
|
252
267
|
|
253
268
|
# Builds the object from hash
|
@@ -30,9 +30,6 @@ module SibApiV3Sdk
|
|
30
30
|
# UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format
|
31
31
|
attr_accessor :scheduled_at
|
32
32
|
|
33
|
-
# Retrieved the status of test SMS sending. (true=Test SMS has been sent false=Test SMS has not been sent)
|
34
|
-
attr_accessor :test_sent
|
35
|
-
|
36
33
|
# Sender of the SMS Campaign
|
37
34
|
attr_accessor :sender
|
38
35
|
|
@@ -76,7 +73,6 @@ module SibApiV3Sdk
|
|
76
73
|
:'status' => :'status',
|
77
74
|
:'content' => :'content',
|
78
75
|
:'scheduled_at' => :'scheduledAt',
|
79
|
-
:'test_sent' => :'testSent',
|
80
76
|
:'sender' => :'sender',
|
81
77
|
:'created_at' => :'createdAt',
|
82
78
|
:'modified_at' => :'modifiedAt',
|
@@ -93,7 +89,6 @@ module SibApiV3Sdk
|
|
93
89
|
:'status' => :'String',
|
94
90
|
:'content' => :'String',
|
95
91
|
:'scheduled_at' => :'DateTime',
|
96
|
-
:'test_sent' => :'BOOLEAN',
|
97
92
|
:'sender' => :'String',
|
98
93
|
:'created_at' => :'DateTime',
|
99
94
|
:'modified_at' => :'DateTime',
|
@@ -130,10 +125,6 @@ module SibApiV3Sdk
|
|
130
125
|
self.scheduled_at = attributes[:'scheduledAt']
|
131
126
|
end
|
132
127
|
|
133
|
-
if attributes.has_key?(:'testSent')
|
134
|
-
self.test_sent = attributes[:'testSent']
|
135
|
-
end
|
136
|
-
|
137
128
|
if attributes.has_key?(:'sender')
|
138
129
|
self.sender = attributes[:'sender']
|
139
130
|
end
|
@@ -180,10 +171,6 @@ module SibApiV3Sdk
|
|
180
171
|
invalid_properties.push("invalid value for 'scheduled_at', scheduled_at cannot be nil.")
|
181
172
|
end
|
182
173
|
|
183
|
-
if @test_sent.nil?
|
184
|
-
invalid_properties.push("invalid value for 'test_sent', test_sent cannot be nil.")
|
185
|
-
end
|
186
|
-
|
187
174
|
if @sender.nil?
|
188
175
|
invalid_properties.push("invalid value for 'sender', sender cannot be nil.")
|
189
176
|
end
|
@@ -213,11 +200,10 @@ module SibApiV3Sdk
|
|
213
200
|
return false if @id.nil?
|
214
201
|
return false if @name.nil?
|
215
202
|
return false if @status.nil?
|
216
|
-
status_validator = EnumAttributeValidator.new('String', ["draft", "sent", "archive", "queued", "suspended", "
|
203
|
+
status_validator = EnumAttributeValidator.new('String', ["draft", "sent", "archive", "queued", "suspended", "inProcess"])
|
217
204
|
return false unless status_validator.valid?(@status)
|
218
205
|
return false if @content.nil?
|
219
206
|
return false if @scheduled_at.nil?
|
220
|
-
return false if @test_sent.nil?
|
221
207
|
return false if @sender.nil?
|
222
208
|
return false if @created_at.nil?
|
223
209
|
return false if @modified_at.nil?
|
@@ -229,7 +215,7 @@ module SibApiV3Sdk
|
|
229
215
|
# Custom attribute writer method checking allowed values (enum).
|
230
216
|
# @param [Object] status Object to be assigned
|
231
217
|
def status=(status)
|
232
|
-
validator = EnumAttributeValidator.new('String', ["draft", "sent", "archive", "queued", "suspended", "
|
218
|
+
validator = EnumAttributeValidator.new('String', ["draft", "sent", "archive", "queued", "suspended", "inProcess"])
|
233
219
|
unless validator.valid?(status)
|
234
220
|
fail ArgumentError, "invalid value for 'status', must be one of #{validator.allowable_values}."
|
235
221
|
end
|
@@ -246,7 +232,6 @@ module SibApiV3Sdk
|
|
246
232
|
status == o.status &&
|
247
233
|
content == o.content &&
|
248
234
|
scheduled_at == o.scheduled_at &&
|
249
|
-
test_sent == o.test_sent &&
|
250
235
|
sender == o.sender &&
|
251
236
|
created_at == o.created_at &&
|
252
237
|
modified_at == o.modified_at &&
|
@@ -263,7 +248,7 @@ module SibApiV3Sdk
|
|
263
248
|
# Calculates hash code according to all attributes.
|
264
249
|
# @return [Fixnum] Hash code
|
265
250
|
def hash
|
266
|
-
[id, name, status, content, scheduled_at,
|
251
|
+
[id, name, status, content, scheduled_at, sender, created_at, modified_at, recipients, statistics].hash
|
267
252
|
end
|
268
253
|
|
269
254
|
# Builds the object from hash
|
@@ -30,9 +30,6 @@ module SibApiV3Sdk
|
|
30
30
|
# UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format
|
31
31
|
attr_accessor :scheduled_at
|
32
32
|
|
33
|
-
# Retrieved the status of test SMS sending. (true=Test SMS has been sent false=Test SMS has not been sent)
|
34
|
-
attr_accessor :test_sent
|
35
|
-
|
36
33
|
# Sender of the SMS Campaign
|
37
34
|
attr_accessor :sender
|
38
35
|
|
@@ -72,7 +69,6 @@ module SibApiV3Sdk
|
|
72
69
|
:'status' => :'status',
|
73
70
|
:'content' => :'content',
|
74
71
|
:'scheduled_at' => :'scheduledAt',
|
75
|
-
:'test_sent' => :'testSent',
|
76
72
|
:'sender' => :'sender',
|
77
73
|
:'created_at' => :'createdAt',
|
78
74
|
:'modified_at' => :'modifiedAt'
|
@@ -87,7 +83,6 @@ module SibApiV3Sdk
|
|
87
83
|
:'status' => :'String',
|
88
84
|
:'content' => :'String',
|
89
85
|
:'scheduled_at' => :'DateTime',
|
90
|
-
:'test_sent' => :'BOOLEAN',
|
91
86
|
:'sender' => :'String',
|
92
87
|
:'created_at' => :'DateTime',
|
93
88
|
:'modified_at' => :'DateTime'
|
@@ -122,10 +117,6 @@ module SibApiV3Sdk
|
|
122
117
|
self.scheduled_at = attributes[:'scheduledAt']
|
123
118
|
end
|
124
119
|
|
125
|
-
if attributes.has_key?(:'testSent')
|
126
|
-
self.test_sent = attributes[:'testSent']
|
127
|
-
end
|
128
|
-
|
129
120
|
if attributes.has_key?(:'sender')
|
130
121
|
self.sender = attributes[:'sender']
|
131
122
|
end
|
@@ -164,10 +155,6 @@ module SibApiV3Sdk
|
|
164
155
|
invalid_properties.push("invalid value for 'scheduled_at', scheduled_at cannot be nil.")
|
165
156
|
end
|
166
157
|
|
167
|
-
if @test_sent.nil?
|
168
|
-
invalid_properties.push("invalid value for 'test_sent', test_sent cannot be nil.")
|
169
|
-
end
|
170
|
-
|
171
158
|
if @sender.nil?
|
172
159
|
invalid_properties.push("invalid value for 'sender', sender cannot be nil.")
|
173
160
|
end
|
@@ -189,11 +176,10 @@ module SibApiV3Sdk
|
|
189
176
|
return false if @id.nil?
|
190
177
|
return false if @name.nil?
|
191
178
|
return false if @status.nil?
|
192
|
-
status_validator = EnumAttributeValidator.new('String', ["draft", "sent", "archive", "queued", "suspended", "
|
179
|
+
status_validator = EnumAttributeValidator.new('String', ["draft", "sent", "archive", "queued", "suspended", "inProcess"])
|
193
180
|
return false unless status_validator.valid?(@status)
|
194
181
|
return false if @content.nil?
|
195
182
|
return false if @scheduled_at.nil?
|
196
|
-
return false if @test_sent.nil?
|
197
183
|
return false if @sender.nil?
|
198
184
|
return false if @created_at.nil?
|
199
185
|
return false if @modified_at.nil?
|
@@ -203,7 +189,7 @@ module SibApiV3Sdk
|
|
203
189
|
# Custom attribute writer method checking allowed values (enum).
|
204
190
|
# @param [Object] status Object to be assigned
|
205
191
|
def status=(status)
|
206
|
-
validator = EnumAttributeValidator.new('String', ["draft", "sent", "archive", "queued", "suspended", "
|
192
|
+
validator = EnumAttributeValidator.new('String', ["draft", "sent", "archive", "queued", "suspended", "inProcess"])
|
207
193
|
unless validator.valid?(status)
|
208
194
|
fail ArgumentError, "invalid value for 'status', must be one of #{validator.allowable_values}."
|
209
195
|
end
|
@@ -220,7 +206,6 @@ module SibApiV3Sdk
|
|
220
206
|
status == o.status &&
|
221
207
|
content == o.content &&
|
222
208
|
scheduled_at == o.scheduled_at &&
|
223
|
-
test_sent == o.test_sent &&
|
224
209
|
sender == o.sender &&
|
225
210
|
created_at == o.created_at &&
|
226
211
|
modified_at == o.modified_at
|
@@ -235,7 +220,7 @@ module SibApiV3Sdk
|
|
235
220
|
# Calculates hash code according to all attributes.
|
236
221
|
# @return [Fixnum] Hash code
|
237
222
|
def hash
|
238
|
-
[id, name, status, content, scheduled_at,
|
223
|
+
[id, name, status, content, scheduled_at, sender, created_at, modified_at].hash
|
239
224
|
end
|
240
225
|
|
241
226
|
# Builds the object from hash
|
@@ -33,7 +33,7 @@ module SibApiV3Sdk
|
|
33
33
|
# Pass the list of content (base64 encoded) and name of the attachment. For example, [{'content':'base64 encoded content 1', 'name':'attcahment1'}, {'content':'base64 encoded content 2', 'name':'attcahment2'}].
|
34
34
|
attr_accessor :attachment
|
35
35
|
|
36
|
-
# Pass the set of headers that shall be sent along the mail headers in the original email. '
|
36
|
+
# Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'}
|
37
37
|
attr_accessor :headers
|
38
38
|
|
39
39
|
# Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}
|
@@ -40,13 +40,13 @@ module SibApiV3Sdk
|
|
40
40
|
# Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, [{'url':'https://attachment.domain.com/myAttachmentFromUrl.jpg', 'name':'My attachment 1'}, {'content':'base64 exmaple content', 'name':'My attachment 2'}]. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps ( Ignored if 'templateId' is passed )
|
41
41
|
attr_accessor :attachment
|
42
42
|
|
43
|
-
# Pass the set of headers that shall be sent along the mail headers in the original email. '
|
43
|
+
# Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'}
|
44
44
|
attr_accessor :headers
|
45
45
|
|
46
46
|
# Id of the template
|
47
47
|
attr_accessor :template_id
|
48
48
|
|
49
|
-
# Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}.
|
49
|
+
# Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. It's considered only if template is in New Template Language format.
|
50
50
|
attr_accessor :params
|
51
51
|
|
52
52
|
# Tag your emails to find them more easily
|
@@ -24,7 +24,7 @@ module SibApiV3Sdk
|
|
24
24
|
# Content of the message. If more than 160 characters long, will be sent as multiple text messages
|
25
25
|
attr_accessor :content
|
26
26
|
|
27
|
-
# Type of the SMS
|
27
|
+
# Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc.
|
28
28
|
attr_accessor :type
|
29
29
|
|
30
30
|
# Tag of the message
|
@@ -64,7 +64,7 @@ module SibApiV3Sdk
|
|
64
64
|
# Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed
|
65
65
|
attr_accessor :utm_campaign
|
66
66
|
|
67
|
-
# Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}.
|
67
|
+
# Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField'
|
68
68
|
attr_accessor :params
|
69
69
|
|
70
70
|
|
@@ -74,6 +74,8 @@ describe 'SMSCampaignsApi' do
|
|
74
74
|
#
|
75
75
|
# @param [Hash] opts the optional parameters
|
76
76
|
# @option opts [String] :status Status of campaign.
|
77
|
+
# @option opts [DateTime] :start_date Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms 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' )
|
78
|
+
# @option opts [DateTime] :end_date Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms 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' )
|
77
79
|
# @option opts [Integer] :limit Number limitation for the result returned
|
78
80
|
# @option opts [Integer] :offset Beginning point in the list to retrieve from.
|
79
81
|
# @return [GetSmsCampaigns]
|
@@ -104,5 +104,11 @@ describe 'GetAggregatedReport' do
|
|
104
104
|
end
|
105
105
|
end
|
106
106
|
|
107
|
+
describe 'test attribute "unsubscribed"' do
|
108
|
+
it 'should work' do
|
109
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
110
|
+
end
|
111
|
+
end
|
112
|
+
|
107
113
|
end
|
108
114
|
|
@@ -59,7 +59,7 @@ describe 'GetEmailEventReportEvents' do
|
|
59
59
|
describe 'test attribute "event"' do
|
60
60
|
it 'should work' do
|
61
61
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
62
|
-
#validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["bounces", "hardBounces", "softBounces", "delivered", "spam", "requests", "opened", "clicks", "invalid", "deferred", "blocked"])
|
62
|
+
#validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["bounces", "hardBounces", "softBounces", "delivered", "spam", "requests", "opened", "clicks", "invalid", "deferred", "blocked", "unsubscribed"])
|
63
63
|
#validator.allowable_values.each do |value|
|
64
64
|
# expect { @instance.event = value }.not_to raise_error
|
65
65
|
#end
|
@@ -104,5 +104,11 @@ describe 'GetReportsReports' do
|
|
104
104
|
end
|
105
105
|
end
|
106
106
|
|
107
|
+
describe 'test attribute "unsubscribed"' do
|
108
|
+
it 'should work' do
|
109
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
110
|
+
end
|
111
|
+
end
|
112
|
+
|
107
113
|
end
|
108
114
|
|
@@ -47,7 +47,7 @@ describe 'GetSmsCampaignOverview' do
|
|
47
47
|
describe 'test attribute "status"' do
|
48
48
|
it 'should work' do
|
49
49
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
50
|
-
#validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["draft", "sent", "archive", "queued", "suspended", "
|
50
|
+
#validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["draft", "sent", "archive", "queued", "suspended", "inProcess"])
|
51
51
|
#validator.allowable_values.each do |value|
|
52
52
|
# expect { @instance.status = value }.not_to raise_error
|
53
53
|
#end
|
@@ -66,12 +66,6 @@ describe 'GetSmsCampaignOverview' do
|
|
66
66
|
end
|
67
67
|
end
|
68
68
|
|
69
|
-
describe 'test attribute "test_sent"' do
|
70
|
-
it 'should work' do
|
71
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
72
|
-
end
|
73
|
-
end
|
74
|
-
|
75
69
|
describe 'test attribute "sender"' do
|
76
70
|
it 'should work' do
|
77
71
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -47,7 +47,7 @@ describe 'GetSmsCampaign' do
|
|
47
47
|
describe 'test attribute "status"' do
|
48
48
|
it 'should work' do
|
49
49
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
50
|
-
#validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["draft", "sent", "archive", "queued", "suspended", "
|
50
|
+
#validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["draft", "sent", "archive", "queued", "suspended", "inProcess"])
|
51
51
|
#validator.allowable_values.each do |value|
|
52
52
|
# expect { @instance.status = value }.not_to raise_error
|
53
53
|
#end
|
@@ -66,12 +66,6 @@ describe 'GetSmsCampaign' do
|
|
66
66
|
end
|
67
67
|
end
|
68
68
|
|
69
|
-
describe 'test attribute "test_sent"' do
|
70
|
-
it 'should work' do
|
71
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
72
|
-
end
|
73
|
-
end
|
74
|
-
|
75
69
|
describe 'test attribute "sender"' do
|
76
70
|
it 'should work' do
|
77
71
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
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.1.
|
4
|
+
version: 5.1.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: 2018-
|
11
|
+
date: 2018-11-28 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|