sib-api-v3-sdk 7.2.0 → 7.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (45) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -0
  3. data/docs/ContactsApi.md +10 -10
  4. data/docs/CreateSmtpEmail.md +2 -1
  5. data/docs/EmailCampaignsApi.md +2 -2
  6. data/docs/FoldersApi.md +4 -4
  7. data/docs/ListsApi.md +6 -6
  8. data/docs/ProcessApi.md +2 -2
  9. data/docs/SMSCampaignsApi.md +2 -2
  10. data/docs/SendSmtpEmail.md +3 -2
  11. data/docs/SendSmtpEmailMessageVersions.md +13 -0
  12. data/docs/SendSmtpEmailReplyTo1.md +9 -0
  13. data/docs/SendSmtpEmailTo1.md +9 -0
  14. data/docs/TransactionalEmailsApi.md +10 -10
  15. data/docs/TransactionalSMSApi.md +4 -4
  16. data/lib/sib-api-v3-sdk.rb +3 -0
  17. data/lib/sib-api-v3-sdk/api/contacts_api.rb +10 -10
  18. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +2 -2
  19. data/lib/sib-api-v3-sdk/api/folders_api.rb +4 -4
  20. data/lib/sib-api-v3-sdk/api/lists_api.rb +6 -6
  21. data/lib/sib-api-v3-sdk/api/process_api.rb +2 -2
  22. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +2 -2
  23. data/lib/sib-api-v3-sdk/api/transactional_emails_api.rb +10 -10
  24. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +4 -4
  25. data/lib/sib-api-v3-sdk/models/create_smtp_email.rb +15 -9
  26. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +15 -8
  27. data/lib/sib-api-v3-sdk/models/send_smtp_email_message_versions.rb +246 -0
  28. data/lib/sib-api-v3-sdk/models/send_smtp_email_reply_to_1.rb +200 -0
  29. data/lib/sib-api-v3-sdk/models/send_smtp_email_to_1.rb +199 -0
  30. data/lib/sib-api-v3-sdk/version.rb +1 -1
  31. data/spec/api/contacts_api_spec.rb +5 -5
  32. data/spec/api/email_campaigns_api_spec.rb +1 -1
  33. data/spec/api/folders_api_spec.rb +2 -2
  34. data/spec/api/lists_api_spec.rb +3 -3
  35. data/spec/api/process_api_spec.rb +1 -1
  36. data/spec/api/sms_campaigns_api_spec.rb +1 -1
  37. data/spec/api/transactional_emails_api_spec.rb +5 -5
  38. data/spec/api/transactional_sms_api_spec.rb +2 -2
  39. data/spec/models/create_smtp_email_spec.rb +6 -0
  40. data/spec/models/send_smtp_email_message_versions_spec.rb +71 -0
  41. data/spec/models/send_smtp_email_reply_to_1_spec.rb +47 -0
  42. data/spec/models/send_smtp_email_spec.rb +6 -0
  43. data/spec/models/send_smtp_email_to_1_spec.rb +47 -0
  44. metadata +14 -3
  45. data/testfile.rb +0 -26
@@ -736,7 +736,7 @@ module SibApiV3Sdk
736
736
  # @option opts [Integer] :limit Number of documents per page (default to 50)
737
737
  # @option opts [Integer] :offset Index of the first document of the page (default to 0)
738
738
  # @option opts [DateTime] :modified_since 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.
739
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
739
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (default to desc)
740
740
  # @return [GetContacts]
741
741
  def get_contacts(opts = {})
742
742
  data, _status_code, _headers = get_contacts_with_http_info(opts)
@@ -748,7 +748,7 @@ module SibApiV3Sdk
748
748
  # @option opts [Integer] :limit Number of documents per page
749
749
  # @option opts [Integer] :offset Index of the first document of the page
750
750
  # @option opts [DateTime] :modified_since 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.
751
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
751
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
752
752
  # @return [Array<(GetContacts, Fixnum, Hash)>] GetContacts data, response status code and response headers
753
753
  def get_contacts_with_http_info(opts = {})
754
754
  if @api_client.config.debugging
@@ -802,7 +802,7 @@ module SibApiV3Sdk
802
802
  # @option opts [DateTime] :modified_since 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.
803
803
  # @option opts [Integer] :limit Number of documents per page (default to 50)
804
804
  # @option opts [Integer] :offset Index of the first document of the page (default to 0)
805
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
805
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
806
806
  # @return [GetContacts]
807
807
  def get_contacts_from_list(list_id, opts = {})
808
808
  data, _status_code, _headers = get_contacts_from_list_with_http_info(list_id, opts)
@@ -815,7 +815,7 @@ module SibApiV3Sdk
815
815
  # @option opts [DateTime] :modified_since 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.
816
816
  # @option opts [Integer] :limit Number of documents per page
817
817
  # @option opts [Integer] :offset Index of the first document of the page
818
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
818
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
819
819
  # @return [Array<(GetContacts, Fixnum, Hash)>] GetContacts data, response status code and response headers
820
820
  def get_contacts_from_list_with_http_info(list_id, opts = {})
821
821
  if @api_client.config.debugging
@@ -924,7 +924,7 @@ module SibApiV3Sdk
924
924
  # @param [Hash] opts the optional parameters
925
925
  # @option opts [Integer] :limit Number of documents per page (default to 10)
926
926
  # @option opts [Integer] :offset Index of the first document of the page (default to 0)
927
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
927
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
928
928
  # @return [GetFolderLists]
929
929
  def get_folder_lists(folder_id, opts = {})
930
930
  data, _status_code, _headers = get_folder_lists_with_http_info(folder_id, opts)
@@ -936,7 +936,7 @@ module SibApiV3Sdk
936
936
  # @param [Hash] opts the optional parameters
937
937
  # @option opts [Integer] :limit Number of documents per page
938
938
  # @option opts [Integer] :offset Index of the first document of the page
939
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
939
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
940
940
  # @return [Array<(GetFolderLists, Fixnum, Hash)>] GetFolderLists data, response status code and response headers
941
941
  def get_folder_lists_with_http_info(folder_id, opts = {})
942
942
  if @api_client.config.debugging
@@ -991,7 +991,7 @@ module SibApiV3Sdk
991
991
  # @param limit Number of documents per page
992
992
  # @param offset Index of the first document of the page
993
993
  # @param [Hash] opts the optional parameters
994
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
994
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
995
995
  # @return [GetFolders]
996
996
  def get_folders(limit, offset, opts = {})
997
997
  data, _status_code, _headers = get_folders_with_http_info(limit, offset, opts)
@@ -1002,7 +1002,7 @@ module SibApiV3Sdk
1002
1002
  # @param limit Number of documents per page
1003
1003
  # @param offset Index of the first document of the page
1004
1004
  # @param [Hash] opts the optional parameters
1005
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
1005
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
1006
1006
  # @return [Array<(GetFolders, Fixnum, Hash)>] GetFolders data, response status code and response headers
1007
1007
  def get_folders_with_http_info(limit, offset, opts = {})
1008
1008
  if @api_client.config.debugging
@@ -1113,7 +1113,7 @@ module SibApiV3Sdk
1113
1113
  # @param [Hash] opts the optional parameters
1114
1114
  # @option opts [Integer] :limit Number of documents per page (default to 10)
1115
1115
  # @option opts [Integer] :offset Index of the first document of the page (default to 0)
1116
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
1116
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
1117
1117
  # @return [GetLists]
1118
1118
  def get_lists(opts = {})
1119
1119
  data, _status_code, _headers = get_lists_with_http_info(opts)
@@ -1124,7 +1124,7 @@ module SibApiV3Sdk
1124
1124
  # @param [Hash] opts the optional parameters
1125
1125
  # @option opts [Integer] :limit Number of documents per page
1126
1126
  # @option opts [Integer] :offset Index of the first document of the page
1127
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
1127
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
1128
1128
  # @return [Array<(GetLists, Fixnum, Hash)>] GetLists data, response status code and response headers
1129
1129
  def get_lists_with_http_info(opts = {})
1130
1130
  if @api_client.config.debugging
@@ -300,7 +300,7 @@ module SibApiV3Sdk
300
300
  # @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 email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either &#39;status&#39; not passed and if passed is set to &#39;sent&#39; )
301
301
  # @option opts [Integer] :limit Number of documents per page (default to 500)
302
302
  # @option opts [Integer] :offset Index of the first document in the page (default to 0)
303
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
303
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
304
304
  # @return [GetEmailCampaigns]
305
305
  def get_email_campaigns(opts = {})
306
306
  data, _status_code, _headers = get_email_campaigns_with_http_info(opts)
@@ -315,7 +315,7 @@ module SibApiV3Sdk
315
315
  # @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 email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either &#39;status&#39; not passed and if passed is set to &#39;sent&#39; )
316
316
  # @option opts [Integer] :limit Number of documents per page
317
317
  # @option opts [Integer] :offset Index of the first document in the page
318
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
318
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
319
319
  # @return [Array<(GetEmailCampaigns, Fixnum, Hash)>] GetEmailCampaigns data, response status code and response headers
320
320
  def get_email_campaigns_with_http_info(opts = {})
321
321
  if @api_client.config.debugging
@@ -189,7 +189,7 @@ module SibApiV3Sdk
189
189
  # @param [Hash] opts the optional parameters
190
190
  # @option opts [Integer] :limit Number of documents per page (default to 10)
191
191
  # @option opts [Integer] :offset Index of the first document of the page (default to 0)
192
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
192
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
193
193
  # @return [GetFolderLists]
194
194
  def get_folder_lists(folder_id, opts = {})
195
195
  data, _status_code, _headers = get_folder_lists_with_http_info(folder_id, opts)
@@ -201,7 +201,7 @@ module SibApiV3Sdk
201
201
  # @param [Hash] opts the optional parameters
202
202
  # @option opts [Integer] :limit Number of documents per page
203
203
  # @option opts [Integer] :offset Index of the first document of the page
204
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
204
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
205
205
  # @return [Array<(GetFolderLists, Fixnum, Hash)>] GetFolderLists data, response status code and response headers
206
206
  def get_folder_lists_with_http_info(folder_id, opts = {})
207
207
  if @api_client.config.debugging
@@ -256,7 +256,7 @@ module SibApiV3Sdk
256
256
  # @param limit Number of documents per page
257
257
  # @param offset Index of the first document of the page
258
258
  # @param [Hash] opts the optional parameters
259
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
259
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
260
260
  # @return [GetFolders]
261
261
  def get_folders(limit, offset, opts = {})
262
262
  data, _status_code, _headers = get_folders_with_http_info(limit, offset, opts)
@@ -267,7 +267,7 @@ module SibApiV3Sdk
267
267
  # @param limit Number of documents per page
268
268
  # @param offset Index of the first document of the page
269
269
  # @param [Hash] opts the optional parameters
270
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
270
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
271
271
  # @return [Array<(GetFolders, Fixnum, Hash)>] GetFolders data, response status code and response headers
272
272
  def get_folders_with_http_info(limit, offset, opts = {})
273
273
  if @api_client.config.debugging
@@ -196,7 +196,7 @@ module SibApiV3Sdk
196
196
  # @option opts [DateTime] :modified_since 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.
197
197
  # @option opts [Integer] :limit Number of documents per page (default to 50)
198
198
  # @option opts [Integer] :offset Index of the first document of the page (default to 0)
199
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
199
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
200
200
  # @return [GetContacts]
201
201
  def get_contacts_from_list(list_id, opts = {})
202
202
  data, _status_code, _headers = get_contacts_from_list_with_http_info(list_id, opts)
@@ -209,7 +209,7 @@ module SibApiV3Sdk
209
209
  # @option opts [DateTime] :modified_since 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.
210
210
  # @option opts [Integer] :limit Number of documents per page
211
211
  # @option opts [Integer] :offset Index of the first document of the page
212
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
212
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
213
213
  # @return [Array<(GetContacts, Fixnum, Hash)>] GetContacts data, response status code and response headers
214
214
  def get_contacts_from_list_with_http_info(list_id, opts = {})
215
215
  if @api_client.config.debugging
@@ -266,7 +266,7 @@ module SibApiV3Sdk
266
266
  # @param [Hash] opts the optional parameters
267
267
  # @option opts [Integer] :limit Number of documents per page (default to 10)
268
268
  # @option opts [Integer] :offset Index of the first document of the page (default to 0)
269
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
269
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
270
270
  # @return [GetFolderLists]
271
271
  def get_folder_lists(folder_id, opts = {})
272
272
  data, _status_code, _headers = get_folder_lists_with_http_info(folder_id, opts)
@@ -278,7 +278,7 @@ module SibApiV3Sdk
278
278
  # @param [Hash] opts the optional parameters
279
279
  # @option opts [Integer] :limit Number of documents per page
280
280
  # @option opts [Integer] :offset Index of the first document of the page
281
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
281
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
282
282
  # @return [Array<(GetFolderLists, Fixnum, Hash)>] GetFolderLists data, response status code and response headers
283
283
  def get_folder_lists_with_http_info(folder_id, opts = {})
284
284
  if @api_client.config.debugging
@@ -385,7 +385,7 @@ module SibApiV3Sdk
385
385
  # @param [Hash] opts the optional parameters
386
386
  # @option opts [Integer] :limit Number of documents per page (default to 10)
387
387
  # @option opts [Integer] :offset Index of the first document of the page (default to 0)
388
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
388
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
389
389
  # @return [GetLists]
390
390
  def get_lists(opts = {})
391
391
  data, _status_code, _headers = get_lists_with_http_info(opts)
@@ -396,7 +396,7 @@ module SibApiV3Sdk
396
396
  # @param [Hash] opts the optional parameters
397
397
  # @option opts [Integer] :limit Number of documents per page
398
398
  # @option opts [Integer] :offset Index of the first document of the page
399
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
399
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
400
400
  # @return [Array<(GetLists, Fixnum, Hash)>] GetLists data, response status code and response headers
401
401
  def get_lists_with_http_info(opts = {})
402
402
  if @api_client.config.debugging
@@ -85,7 +85,7 @@ module SibApiV3Sdk
85
85
  # @param [Hash] opts the optional parameters
86
86
  # @option opts [Integer] :limit Number limitation for the result returned (default to 10)
87
87
  # @option opts [Integer] :offset Beginning point in the list to retrieve from. (default to 0)
88
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
88
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
89
89
  # @return [GetProcesses]
90
90
  def get_processes(opts = {})
91
91
  data, _status_code, _headers = get_processes_with_http_info(opts)
@@ -96,7 +96,7 @@ module SibApiV3Sdk
96
96
  # @param [Hash] opts the optional parameters
97
97
  # @option opts [Integer] :limit Number limitation for the result returned
98
98
  # @option opts [Integer] :offset Beginning point in the list to retrieve from.
99
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
99
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
100
100
  # @return [Array<(GetProcesses, Fixnum, Hash)>] GetProcesses data, response status code and response headers
101
101
  def get_processes_with_http_info(opts = {})
102
102
  if @api_client.config.debugging
@@ -191,7 +191,7 @@ module SibApiV3Sdk
191
191
  # @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 &#39;status&#39; not passed and if passed is set to &#39;sent&#39; )
192
192
  # @option opts [Integer] :limit Number limitation for the result returned (default to 500)
193
193
  # @option opts [Integer] :offset Beginning point in the list to retrieve from. (default to 0)
194
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
194
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
195
195
  # @return [GetSmsCampaigns]
196
196
  def get_sms_campaigns(opts = {})
197
197
  data, _status_code, _headers = get_sms_campaigns_with_http_info(opts)
@@ -205,7 +205,7 @@ module SibApiV3Sdk
205
205
  # @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 &#39;status&#39; not passed and if passed is set to &#39;sent&#39; )
206
206
  # @option opts [Integer] :limit Number limitation for the result returned
207
207
  # @option opts [Integer] :offset Beginning point in the list to retrieve from.
208
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
208
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
209
209
  # @return [Array<(GetSmsCampaigns, Fixnum, Hash)>] GetSmsCampaigns data, response status code and response headers
210
210
  def get_sms_campaigns_with_http_info(opts = {})
211
211
  if @api_client.config.debugging
@@ -405,7 +405,7 @@ module SibApiV3Sdk
405
405
  # @option opts [String] :tags Filter the report for tags (serialized and urlencoded array)
406
406
  # @option opts [String] :message_id Filter on a specific message id
407
407
  # @option opts [Integer] :template_id Filter on a specific template id
408
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
408
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
409
409
  # @return [GetEmailEventReport]
410
410
  def get_email_event_report(opts = {})
411
411
  data, _status_code, _headers = get_email_event_report_with_http_info(opts)
@@ -424,7 +424,7 @@ module SibApiV3Sdk
424
424
  # @option opts [String] :tags Filter the report for tags (serialized and urlencoded array)
425
425
  # @option opts [String] :message_id Filter on a specific message id
426
426
  # @option opts [Integer] :template_id Filter on a specific template id
427
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
427
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
428
428
  # @return [Array<(GetEmailEventReport, Fixnum, Hash)>] GetEmailEventReport data, response status code and response headers
429
429
  def get_email_event_report_with_http_info(opts = {})
430
430
  if @api_client.config.debugging
@@ -490,7 +490,7 @@ module SibApiV3Sdk
490
490
  # @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
491
491
  # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39;
492
492
  # @option opts [String] :tag Tag of the emails
493
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
493
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
494
494
  # @return [GetReports]
495
495
  def get_smtp_report(opts = {})
496
496
  data, _status_code, _headers = get_smtp_report_with_http_info(opts)
@@ -505,7 +505,7 @@ module SibApiV3Sdk
505
505
  # @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
506
506
  # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39;
507
507
  # @option opts [String] :tag Tag of the emails
508
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
508
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
509
509
  # @return [Array<(GetReports, Fixnum, Hash)>] GetReports data, response status code and response headers
510
510
  def get_smtp_report_with_http_info(opts = {})
511
511
  if @api_client.config.debugging
@@ -613,7 +613,7 @@ module SibApiV3Sdk
613
613
  # @option opts [BOOLEAN] :template_status Filter on the status of the template. Active &#x3D; true, inactive &#x3D; false
614
614
  # @option opts [Integer] :limit Number of documents returned per page (default to 50)
615
615
  # @option opts [Integer] :offset Index of the first document in the page (default to 0)
616
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
616
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
617
617
  # @return [GetSmtpTemplates]
618
618
  def get_smtp_templates(opts = {})
619
619
  data, _status_code, _headers = get_smtp_templates_with_http_info(opts)
@@ -625,7 +625,7 @@ module SibApiV3Sdk
625
625
  # @option opts [BOOLEAN] :template_status Filter on the status of the template. Active &#x3D; true, inactive &#x3D; false
626
626
  # @option opts [Integer] :limit Number of documents returned per page
627
627
  # @option opts [Integer] :offset Index of the first document in the page
628
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
628
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
629
629
  # @return [Array<(GetSmtpTemplates, Fixnum, Hash)>] GetSmtpTemplates data, response status code and response headers
630
630
  def get_smtp_templates_with_http_info(opts = {})
631
631
  if @api_client.config.debugging
@@ -680,7 +680,7 @@ module SibApiV3Sdk
680
680
  # @option opts [Integer] :limit Number of documents returned per page (default to 50)
681
681
  # @option opts [Integer] :offset Index of the first document on the page (default to 0)
682
682
  # @option opts [Array<String>] :senders Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
683
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
683
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
684
684
  # @return [GetTransacBlockedContacts]
685
685
  def get_transac_blocked_contacts(opts = {})
686
686
  data, _status_code, _headers = get_transac_blocked_contacts_with_http_info(opts)
@@ -694,7 +694,7 @@ module SibApiV3Sdk
694
694
  # @option opts [Integer] :limit Number of documents returned per page
695
695
  # @option opts [Integer] :offset Index of the first document on the page
696
696
  # @option opts [Array<String>] :senders Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
697
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
697
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
698
698
  # @return [Array<(GetTransacBlockedContacts, Fixnum, Hash)>] GetTransacBlockedContacts data, response status code and response headers
699
699
  def get_transac_blocked_contacts_with_http_info(opts = {})
700
700
  if @api_client.config.debugging
@@ -804,7 +804,7 @@ module SibApiV3Sdk
804
804
  # @option opts [String] :message_id Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
805
805
  # @option opts [Date] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
806
806
  # @option opts [Date] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
807
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
807
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
808
808
  # @return [GetTransacEmailsList]
809
809
  def get_transac_emails_list(opts = {})
810
810
  data, _status_code, _headers = get_transac_emails_list_with_http_info(opts)
@@ -819,7 +819,7 @@ module SibApiV3Sdk
819
819
  # @option opts [String] :message_id Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
820
820
  # @option opts [Date] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
821
821
  # @option opts [Date] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
822
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
822
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
823
823
  # @return [Array<(GetTransacEmailsList, Fixnum, Hash)>] GetTransacEmailsList data, response status code and response headers
824
824
  def get_transac_emails_list_with_http_info(opts = {})
825
825
  if @api_client.config.debugging
@@ -39,7 +39,7 @@ module SibApiV3Sdk
39
39
  # @option opts [String] :phone_number Filter the report for a specific phone number
40
40
  # @option opts [String] :event Filter the report for specific events
41
41
  # @option opts [String] :tags Filter the report for specific tags passed as a serialized urlencoded array
42
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
42
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
43
43
  # @return [GetSmsEventReport]
44
44
  def get_sms_events(opts = {})
45
45
  data, _status_code, _headers = get_sms_events_with_http_info(opts)
@@ -56,7 +56,7 @@ module SibApiV3Sdk
56
56
  # @option opts [String] :phone_number Filter the report for a specific phone number
57
57
  # @option opts [String] :event Filter the report for specific events
58
58
  # @option opts [String] :tags Filter the report for specific tags passed as a serialized urlencoded array
59
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
59
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
60
60
  # @return [Array<(GetSmsEventReport, Fixnum, Hash)>] GetSmsEventReport data, response status code and response headers
61
61
  def get_sms_events_with_http_info(opts = {})
62
62
  if @api_client.config.debugging
@@ -176,7 +176,7 @@ module SibApiV3Sdk
176
176
  # @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
177
177
  # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39;
178
178
  # @option opts [String] :tag Filter on a tag
179
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
179
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
180
180
  # @return [GetTransacSmsReport]
181
181
  def get_transac_sms_report(opts = {})
182
182
  data, _status_code, _headers = get_transac_sms_report_with_http_info(opts)
@@ -189,7 +189,7 @@ module SibApiV3Sdk
189
189
  # @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
190
190
  # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39;
191
191
  # @option opts [String] :tag Filter on a tag
192
- # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
192
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
193
193
  # @return [Array<(GetTransacSmsReport, Fixnum, Hash)>] GetTransacSmsReport data, response status code and response headers
194
194
  def get_transac_sms_report_with_http_info(opts = {})
195
195
  if @api_client.config.debugging
@@ -17,17 +17,21 @@ module SibApiV3Sdk
17
17
  # Message ID of the transactional email sent
18
18
  attr_accessor :message_id
19
19
 
20
+ attr_accessor :message_ids
21
+
20
22
  # Attribute mapping from ruby-style variable name to JSON key.
21
23
  def self.attribute_map
22
24
  {
23
- :'message_id' => :'messageId'
25
+ :'message_id' => :'messageId',
26
+ :'message_ids' => :'messageIds'
24
27
  }
25
28
  end
26
29
 
27
30
  # Attribute type mapping.
28
31
  def self.swagger_types
29
32
  {
30
- :'message_id' => :'String'
33
+ :'message_id' => :'String',
34
+ :'message_ids' => :'Array<String>'
31
35
  }
32
36
  end
33
37
 
@@ -42,23 +46,24 @@ module SibApiV3Sdk
42
46
  if attributes.has_key?(:'messageId')
43
47
  self.message_id = attributes[:'messageId']
44
48
  end
49
+
50
+ if attributes.has_key?(:'messageIds')
51
+ if (value = attributes[:'messageIds']).is_a?(Array)
52
+ self.message_ids = value
53
+ end
54
+ end
45
55
  end
46
56
 
47
57
  # Show invalid properties with the reasons. Usually used together with valid?
48
58
  # @return Array for valid properties with the reasons
49
59
  def list_invalid_properties
50
60
  invalid_properties = Array.new
51
- if @message_id.nil?
52
- invalid_properties.push('invalid value for "message_id", message_id cannot be nil.')
53
- end
54
-
55
61
  invalid_properties
56
62
  end
57
63
 
58
64
  # Check to see if the all the properties in the model are valid
59
65
  # @return true if the model is valid
60
66
  def valid?
61
- return false if @message_id.nil?
62
67
  true
63
68
  end
64
69
 
@@ -67,7 +72,8 @@ module SibApiV3Sdk
67
72
  def ==(o)
68
73
  return true if self.equal?(o)
69
74
  self.class == o.class &&
70
- message_id == o.message_id
75
+ message_id == o.message_id &&
76
+ message_ids == o.message_ids
71
77
  end
72
78
 
73
79
  # @see the `==` method
@@ -79,7 +85,7 @@ module SibApiV3Sdk
79
85
  # Calculates hash code according to all attributes.
80
86
  # @return [Fixnum] Hash code
81
87
  def hash
82
- [message_id].hash
88
+ [message_id, message_ids].hash
83
89
  end
84
90
 
85
91
  # Builds the object from hash
@@ -16,7 +16,7 @@ module SibApiV3Sdk
16
16
  class SendSmtpEmail
17
17
  attr_accessor :sender
18
18
 
19
- # List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}]
19
+ # Mandatory if messageVersions are not passed, ignored if messageVersions are passed. List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}]
20
20
  attr_accessor :to
21
21
 
22
22
  # List of email addresses and names (optional) of the recipients in bcc
@@ -42,12 +42,15 @@ module SibApiV3Sdk
42
42
  # Pass the set of custom headers (not the standard 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. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`.
43
43
  attr_accessor :headers
44
44
 
45
- # Id of the template
45
+ # Id of the template. Mandatory if messageVersions are passed
46
46
  attr_accessor :template_id
47
47
 
48
48
  # 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.
49
49
  attr_accessor :params
50
50
 
51
+ # You can customize and send out multiple versions of a templateId. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. This feature is currently in its beta version. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails
52
+ attr_accessor :message_versions
53
+
51
54
  # Tag your emails to find them more easily
52
55
  attr_accessor :tags
53
56
 
@@ -66,6 +69,7 @@ module SibApiV3Sdk
66
69
  :'headers' => :'headers',
67
70
  :'template_id' => :'templateId',
68
71
  :'params' => :'params',
72
+ :'message_versions' => :'messageVersions',
69
73
  :'tags' => :'tags'
70
74
  }
71
75
  end
@@ -85,6 +89,7 @@ module SibApiV3Sdk
85
89
  :'headers' => :'Object',
86
90
  :'template_id' => :'Integer',
87
91
  :'params' => :'Object',
92
+ :'message_versions' => :'Array<SendSmtpEmailMessageVersions>',
88
93
  :'tags' => :'Array<String>'
89
94
  }
90
95
  end
@@ -153,6 +158,12 @@ module SibApiV3Sdk
153
158
  self.params = attributes[:'params']
154
159
  end
155
160
 
161
+ if attributes.has_key?(:'messageVersions')
162
+ if (value = attributes[:'messageVersions']).is_a?(Array)
163
+ self.message_versions = value
164
+ end
165
+ end
166
+
156
167
  if attributes.has_key?(:'tags')
157
168
  if (value = attributes[:'tags']).is_a?(Array)
158
169
  self.tags = value
@@ -164,17 +175,12 @@ module SibApiV3Sdk
164
175
  # @return Array for valid properties with the reasons
165
176
  def list_invalid_properties
166
177
  invalid_properties = Array.new
167
- if @to.nil?
168
- invalid_properties.push('invalid value for "to", to cannot be nil.')
169
- end
170
-
171
178
  invalid_properties
172
179
  end
173
180
 
174
181
  # Check to see if the all the properties in the model are valid
175
182
  # @return true if the model is valid
176
183
  def valid?
177
- return false if @to.nil?
178
184
  true
179
185
  end
180
186
 
@@ -195,6 +201,7 @@ module SibApiV3Sdk
195
201
  headers == o.headers &&
196
202
  template_id == o.template_id &&
197
203
  params == o.params &&
204
+ message_versions == o.message_versions &&
198
205
  tags == o.tags
199
206
  end
200
207
 
@@ -207,7 +214,7 @@ module SibApiV3Sdk
207
214
  # Calculates hash code according to all attributes.
208
215
  # @return [Fixnum] Hash code
209
216
  def hash
210
- [sender, to, bcc, cc, html_content, text_content, subject, reply_to, attachment, headers, template_id, params, tags].hash
217
+ [sender, to, bcc, cc, html_content, text_content, subject, reply_to, attachment, headers, template_id, params, message_versions, tags].hash
211
218
  end
212
219
 
213
220
  # Builds the object from hash