sib-api-v3-sdk 7.1.0 → 7.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -0
  3. data/docs/BlockDomain.md +8 -0
  4. data/docs/ContactsApi.md +18 -6
  5. data/docs/CreateSmtpTemplateSender.md +1 -1
  6. data/docs/EmailCampaignsApi.md +3 -1
  7. data/docs/FoldersApi.md +9 -3
  8. data/docs/GetBlockedDomains.md +8 -0
  9. data/docs/GetChildDomain.md +2 -2
  10. data/docs/GetChildrenList.md +1 -1
  11. data/docs/GetEmailCampaign.md +2 -2
  12. data/docs/GetEmailCampaigns.md +1 -1
  13. data/docs/GetEmailEventReportEvents.md +1 -0
  14. data/docs/GetExtendedCampaignOverview.md +2 -2
  15. data/docs/GetFolderLists.md +2 -2
  16. data/docs/GetLists.md +2 -2
  17. data/docs/GetProcesses.md +1 -1
  18. data/docs/GetSmsCampaign.md +1 -1
  19. data/docs/GetSmsCampaignOverview.md +1 -1
  20. data/docs/GetSmsCampaigns.md +1 -1
  21. data/docs/GetSmsEventReportEvents.md +4 -4
  22. data/docs/GetTransacAggregatedSmsReport.md +10 -10
  23. data/docs/GetTransacSmsReportReports.md +10 -10
  24. data/docs/ListsApi.md +9 -3
  25. data/docs/ProcessApi.md +3 -1
  26. data/docs/SMSCampaignsApi.md +3 -1
  27. data/docs/SendSmtpEmailSender.md +3 -3
  28. data/docs/TransactionalEmailsApi.md +187 -5
  29. data/docs/TransactionalSMSApi.md +6 -2
  30. data/lib/sib-api-v3-sdk.rb +2 -0
  31. data/lib/sib-api-v3-sdk/api/account_api.rb +10 -0
  32. data/lib/sib-api-v3-sdk/api/attributes_api.rb +10 -0
  33. data/lib/sib-api-v3-sdk/api/contacts_api.rb +40 -0
  34. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +16 -0
  35. data/lib/sib-api-v3-sdk/api/folders_api.rb +22 -0
  36. data/lib/sib-api-v3-sdk/api/lists_api.rb +28 -0
  37. data/lib/sib-api-v3-sdk/api/process_api.rb +16 -0
  38. data/lib/sib-api-v3-sdk/api/reseller_api.rb +10 -0
  39. data/lib/sib-api-v3-sdk/api/senders_api.rb +10 -0
  40. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +16 -0
  41. data/lib/sib-api-v3-sdk/api/transactional_emails_api.rb +196 -2
  42. data/lib/sib-api-v3-sdk/api/transactional_sms_api.rb +22 -0
  43. data/lib/sib-api-v3-sdk/api/webhooks_api.rb +10 -0
  44. data/lib/sib-api-v3-sdk/models/block_domain.rb +189 -0
  45. data/lib/sib-api-v3-sdk/models/create_smtp_template_sender.rb +0 -5
  46. data/lib/sib-api-v3-sdk/models/get_blocked_domains.rb +192 -0
  47. data/lib/sib-api-v3-sdk/models/get_child_domain.rb +0 -10
  48. data/lib/sib-api-v3-sdk/models/get_children_list.rb +0 -5
  49. data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +0 -10
  50. data/lib/sib-api-v3-sdk/models/get_email_campaigns.rb +0 -5
  51. data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +16 -6
  52. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +0 -10
  53. data/lib/sib-api-v3-sdk/models/get_folder_lists.rb +0 -10
  54. data/lib/sib-api-v3-sdk/models/get_lists.rb +0 -10
  55. data/lib/sib-api-v3-sdk/models/get_processes.rb +0 -5
  56. data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +0 -5
  57. data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +0 -5
  58. data/lib/sib-api-v3-sdk/models/get_sms_campaigns.rb +0 -5
  59. data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +0 -20
  60. data/lib/sib-api-v3-sdk/models/get_transac_aggregated_sms_report.rb +0 -50
  61. data/lib/sib-api-v3-sdk/models/get_transac_sms_report_reports.rb +0 -50
  62. data/lib/sib-api-v3-sdk/models/send_smtp_email_sender.rb +4 -9
  63. data/lib/sib-api-v3-sdk/version.rb +1 -1
  64. data/spec/api/contacts_api_spec.rb +5 -0
  65. data/spec/api/email_campaigns_api_spec.rb +1 -0
  66. data/spec/api/folders_api_spec.rb +2 -0
  67. data/spec/api/lists_api_spec.rb +3 -0
  68. data/spec/api/process_api_spec.rb +1 -0
  69. data/spec/api/sms_campaigns_api_spec.rb +1 -0
  70. data/spec/api/transactional_emails_api_spec.rb +40 -0
  71. data/spec/api/transactional_sms_api_spec.rb +2 -0
  72. data/spec/models/block_domain_spec.rb +41 -0
  73. data/spec/models/get_blocked_domains_spec.rb +41 -0
  74. data/spec/models/get_email_event_report_events_spec.rb +7 -1
  75. data/testfile.rb +26 -0
  76. metadata +11 -2
@@ -91,7 +91,8 @@ api_instance = SibApiV3Sdk::ProcessApi.new
91
91
 
92
92
  opts = {
93
93
  limit: 10, # Integer | Number limitation for the result returned
94
- offset: 0 # Integer | Beginning point in the list to retrieve from.
94
+ offset: 0, # Integer | Beginning point in the list to retrieve from.
95
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
95
96
  }
96
97
 
97
98
  begin
@@ -109,6 +110,7 @@ Name | Type | Description | Notes
109
110
  ------------- | ------------- | ------------- | -------------
110
111
  **limit** | **Integer**| Number limitation for the result returned | [optional] [default to 10]
111
112
  **offset** | **Integer**| Beginning point in the list to retrieve from. | [optional] [default to 0]
113
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
112
114
 
113
115
  ### Return type
114
116
 
@@ -215,7 +215,8 @@ opts = {
215
215
  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' )
216
216
  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' )
217
217
  limit: 500, # Integer | Number limitation for the result returned
218
- offset: 0 # Integer | Beginning point in the list to retrieve from.
218
+ offset: 0, # Integer | Beginning point in the list to retrieve from.
219
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
219
220
  }
220
221
 
221
222
  begin
@@ -236,6 +237,7 @@ Name | Type | Description | Notes
236
237
  **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]
237
238
  **limit** | **Integer**| Number limitation for the result returned | [optional] [default to 500]
238
239
  **offset** | **Integer**| Beginning point in the list to retrieve from. | [optional] [default to 0]
240
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
239
241
 
240
242
  ### Return type
241
243
 
@@ -3,8 +3,8 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **name** | **String** | Name of the sender from which the emails will be sent. Maximum allowed characters are 70. | [optional]
7
- **email** | **String** | Email of the sender from which the emails will be sent |
8
- **id** | **Integer** | Id of the sender from which the emails will be sent | [optional]
6
+ **name** | **String** | Name of the sender from which the emails will be sent. Maximum allowed characters are 70. Applicable only when email is passed. | [optional]
7
+ **email** | **String** | Email of the sender from which the emails will be sent. Mandatory if sender id is not passed. | [optional]
8
+ **id** | **Integer** | Id of the sender from which the emails will be sent. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). Mandatory if email is not passed. | [optional]
9
9
 
10
10
 
@@ -4,10 +4,13 @@ All URIs are relative to *https://api.sendinblue.com/v3*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**block_new_domain**](TransactionalEmailsApi.md#block_new_domain) | **POST** /smtp/blockedDomains | Add a new domain to the list of blocked domains
7
8
  [**create_smtp_template**](TransactionalEmailsApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
9
+ [**delete_blocked_domain**](TransactionalEmailsApi.md#delete_blocked_domain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains
8
10
  [**delete_hardbounces**](TransactionalEmailsApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
9
11
  [**delete_smtp_template**](TransactionalEmailsApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
10
12
  [**get_aggregated_smtp_report**](TransactionalEmailsApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
13
+ [**get_blocked_domains**](TransactionalEmailsApi.md#get_blocked_domains) | **GET** /smtp/blockedDomains | Get the list of blocked domains
11
14
  [**get_email_event_report**](TransactionalEmailsApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
12
15
  [**get_smtp_report**](TransactionalEmailsApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
13
16
  [**get_smtp_template**](TransactionalEmailsApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
@@ -23,6 +26,64 @@ Method | HTTP request | Description
23
26
  [**update_smtp_template**](TransactionalEmailsApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template
24
27
 
25
28
 
29
+ # **block_new_domain**
30
+ > block_new_domain(block_domain)
31
+
32
+ Add a new domain to the list of blocked domains
33
+
34
+ Blocks a new domain in order to avoid messages being sent to the same
35
+
36
+ ### Example
37
+ ```ruby
38
+ # load the gem
39
+ require 'sib-api-v3-sdk'
40
+ # setup authorization
41
+ SibApiV3Sdk.configure do |config|
42
+ # Configure API key authorization: api-key
43
+ config.api_key['api-key'] = 'YOUR API KEY'
44
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
45
+ #config.api_key_prefix['api-key'] = 'Bearer'
46
+
47
+ # Configure API key authorization: partner-key
48
+ config.api_key['partner-key'] = 'YOUR API KEY'
49
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
50
+ #config.api_key_prefix['partner-key'] = 'Bearer'
51
+ end
52
+
53
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
54
+
55
+ block_domain = SibApiV3Sdk::BlockDomain.new # BlockDomain |
56
+
57
+
58
+ begin
59
+ #Add a new domain to the list of blocked domains
60
+ api_instance.block_new_domain(block_domain)
61
+ rescue SibApiV3Sdk::ApiError => e
62
+ puts "Exception when calling TransactionalEmailsApi->block_new_domain: #{e}"
63
+ end
64
+ ```
65
+
66
+ ### Parameters
67
+
68
+ Name | Type | Description | Notes
69
+ ------------- | ------------- | ------------- | -------------
70
+ **block_domain** | [**BlockDomain**](BlockDomain.md)| |
71
+
72
+ ### Return type
73
+
74
+ nil (empty response body)
75
+
76
+ ### Authorization
77
+
78
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
79
+
80
+ ### HTTP request headers
81
+
82
+ - **Content-Type**: application/json
83
+ - **Accept**: application/json
84
+
85
+
86
+
26
87
  # **create_smtp_template**
27
88
  > CreateModel create_smtp_template(smtp_template)
28
89
 
@@ -80,6 +141,64 @@ Name | Type | Description | Notes
80
141
 
81
142
 
82
143
 
144
+ # **delete_blocked_domain**
145
+ > delete_blocked_domain(domain)
146
+
147
+ Unblock an existing domain from the list of blocked domains
148
+
149
+ Unblocks an existing domain from the list of blocked domains
150
+
151
+ ### Example
152
+ ```ruby
153
+ # load the gem
154
+ require 'sib-api-v3-sdk'
155
+ # setup authorization
156
+ SibApiV3Sdk.configure do |config|
157
+ # Configure API key authorization: api-key
158
+ config.api_key['api-key'] = 'YOUR API KEY'
159
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
160
+ #config.api_key_prefix['api-key'] = 'Bearer'
161
+
162
+ # Configure API key authorization: partner-key
163
+ config.api_key['partner-key'] = 'YOUR API KEY'
164
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
165
+ #config.api_key_prefix['partner-key'] = 'Bearer'
166
+ end
167
+
168
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
169
+
170
+ domain = 'domain_example' # String | The name of the domain to be deleted
171
+
172
+
173
+ begin
174
+ #Unblock an existing domain from the list of blocked domains
175
+ api_instance.delete_blocked_domain(domain)
176
+ rescue SibApiV3Sdk::ApiError => e
177
+ puts "Exception when calling TransactionalEmailsApi->delete_blocked_domain: #{e}"
178
+ end
179
+ ```
180
+
181
+ ### Parameters
182
+
183
+ Name | Type | Description | Notes
184
+ ------------- | ------------- | ------------- | -------------
185
+ **domain** | **String**| The name of the domain to be deleted |
186
+
187
+ ### Return type
188
+
189
+ nil (empty response body)
190
+
191
+ ### Authorization
192
+
193
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
194
+
195
+ ### HTTP request headers
196
+
197
+ - **Content-Type**: application/json
198
+ - **Accept**: application/json
199
+
200
+
201
+
83
202
  # **delete_hardbounces**
84
203
  > delete_hardbounces(opts)
85
204
 
@@ -259,6 +378,59 @@ Name | Type | Description | Notes
259
378
 
260
379
 
261
380
 
381
+ # **get_blocked_domains**
382
+ > GetBlockedDomains get_blocked_domains
383
+
384
+ Get the list of blocked domains
385
+
386
+ Get the list of blocked domains
387
+
388
+ ### Example
389
+ ```ruby
390
+ # load the gem
391
+ require 'sib-api-v3-sdk'
392
+ # setup authorization
393
+ SibApiV3Sdk.configure do |config|
394
+ # Configure API key authorization: api-key
395
+ config.api_key['api-key'] = 'YOUR API KEY'
396
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
397
+ #config.api_key_prefix['api-key'] = 'Bearer'
398
+
399
+ # Configure API key authorization: partner-key
400
+ config.api_key['partner-key'] = 'YOUR API KEY'
401
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
402
+ #config.api_key_prefix['partner-key'] = 'Bearer'
403
+ end
404
+
405
+ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
406
+
407
+ begin
408
+ #Get the list of blocked domains
409
+ result = api_instance.get_blocked_domains
410
+ p result
411
+ rescue SibApiV3Sdk::ApiError => e
412
+ puts "Exception when calling TransactionalEmailsApi->get_blocked_domains: #{e}"
413
+ end
414
+ ```
415
+
416
+ ### Parameters
417
+ This endpoint does not need any parameter.
418
+
419
+ ### Return type
420
+
421
+ [**GetBlockedDomains**](GetBlockedDomains.md)
422
+
423
+ ### Authorization
424
+
425
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
426
+
427
+ ### HTTP request headers
428
+
429
+ - **Content-Type**: application/json
430
+ - **Accept**: application/json
431
+
432
+
433
+
262
434
  # **get_email_event_report**
263
435
  > GetEmailEventReport get_email_event_report(opts)
264
436
 
@@ -293,7 +465,8 @@ opts = {
293
465
  event: 'event_example', # String | Filter the report for a specific event type
294
466
  tags: 'tags_example', # String | Filter the report for tags (serialized and urlencoded array)
295
467
  message_id: 'message_id_example', # String | Filter on a specific message id
296
- template_id: 789 # Integer | Filter on a specific template id
468
+ template_id: 789, # Integer | Filter on a specific template id
469
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
297
470
  }
298
471
 
299
472
  begin
@@ -319,6 +492,7 @@ Name | Type | Description | Notes
319
492
  **tags** | **String**| Filter the report for tags (serialized and urlencoded array) | [optional]
320
493
  **message_id** | **String**| Filter on a specific message id | [optional]
321
494
  **template_id** | **Integer**| Filter on a specific template id | [optional]
495
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
322
496
 
323
497
  ### Return type
324
498
 
@@ -365,7 +539,8 @@ opts = {
365
539
  start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
366
540
  end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
367
541
  days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
368
- tag: 'tag_example' # String | Tag of the emails
542
+ tag: 'tag_example', # String | Tag of the emails
543
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
369
544
  }
370
545
 
371
546
  begin
@@ -387,6 +562,7 @@ Name | Type | Description | Notes
387
562
  **end_date** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional]
388
563
  **days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
389
564
  **tag** | **String**| Tag of the emails | [optional]
565
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
390
566
 
391
567
  ### Return type
392
568
 
@@ -487,7 +663,8 @@ api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
487
663
  opts = {
488
664
  template_status: true, # BOOLEAN | Filter on the status of the template. Active = true, inactive = false
489
665
  limit: 50, # Integer | Number of documents returned per page
490
- offset: 0 # Integer | Index of the first document in the page
666
+ offset: 0, # Integer | Index of the first document in the page
667
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
491
668
  }
492
669
 
493
670
  begin
@@ -506,6 +683,7 @@ Name | Type | Description | Notes
506
683
  **template_status** | **BOOLEAN**| Filter on the status of the template. Active = true, inactive = false | [optional]
507
684
  **limit** | **Integer**| Number of documents returned per page | [optional] [default to 50]
508
685
  **offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
686
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
509
687
 
510
688
  ### Return type
511
689
 
@@ -551,7 +729,8 @@ opts = {
551
729
  end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
552
730
  limit: 50, # Integer | Number of documents returned per page
553
731
  offset: 0, # Integer | Index of the first document on the page
554
- senders: ['senders_example'] # Array<String> | Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
732
+ senders: ['senders_example'], # Array<String> | Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
733
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
555
734
  }
556
735
 
557
736
  begin
@@ -572,6 +751,7 @@ Name | Type | Description | Notes
572
751
  **limit** | **Integer**| Number of documents returned per page | [optional] [default to 50]
573
752
  **offset** | **Integer**| Index of the first document on the page | [optional] [default to 0]
574
753
  **senders** | [**Array&lt;String&gt;**](String.md)| Comma separated list of emails of the senders from which contacts are blocked or unsubscribed | [optional]
754
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
575
755
 
576
756
  ### Return type
577
757
 
@@ -676,7 +856,8 @@ opts = {
676
856
  template_id: 789, # Integer | Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
677
857
  message_id: 'message_id_example', # String | Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
678
858
  start_date: Date.parse('2013-10-20'), # 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.
679
- end_date: Date.parse('2013-10-20') # 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.
859
+ end_date: Date.parse('2013-10-20'), # 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.
860
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
680
861
  }
681
862
 
682
863
  begin
@@ -697,6 +878,7 @@ Name | Type | Description | Notes
697
878
  **message_id** | **String**| Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. | [optional]
698
879
  **start_date** | **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. | [optional]
699
880
  **end_date** | **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. | [optional]
881
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
700
882
 
701
883
  ### Return type
702
884
 
@@ -42,7 +42,8 @@ opts = {
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
44
44
  event: 'event_example', # String | Filter the report for specific events
45
- tags: 'tags_example' # String | Filter the report for specific tags passed as a serialized urlencoded array
45
+ tags: 'tags_example', # String | Filter the report for specific tags passed as a serialized urlencoded array
46
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
46
47
  }
47
48
 
48
49
  begin
@@ -66,6 +67,7 @@ Name | Type | Description | Notes
66
67
  **phone_number** | **String**| Filter the report for a specific phone number | [optional]
67
68
  **event** | **String**| Filter the report for specific events | [optional]
68
69
  **tags** | **String**| Filter the report for specific tags passed as a serialized urlencoded array | [optional]
70
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
69
71
 
70
72
  ### Return type
71
73
 
@@ -174,7 +176,8 @@ opts = {
174
176
  start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
175
177
  end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
176
178
  days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
177
- tag: 'tag_example' # String | Filter on a tag
179
+ tag: 'tag_example', # String | Filter on a tag
180
+ sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
178
181
  }
179
182
 
180
183
  begin
@@ -194,6 +197,7 @@ Name | Type | Description | Notes
194
197
  **end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
195
198
  **days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39; | [optional]
196
199
  **tag** | **String**| Filter on a tag | [optional]
200
+ **sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
197
201
 
198
202
  ### Return type
199
203
 
@@ -26,6 +26,7 @@ require 'sib-api-v3-sdk/models/ab_test_version_stats'
26
26
  require 'sib-api-v3-sdk/models/add_child_domain'
27
27
  require 'sib-api-v3-sdk/models/add_contact_to_list'
28
28
  require 'sib-api-v3-sdk/models/add_credits'
29
+ require 'sib-api-v3-sdk/models/block_domain'
29
30
  require 'sib-api-v3-sdk/models/create_attribute'
30
31
  require 'sib-api-v3-sdk/models/create_attribute_enumeration'
31
32
  require 'sib-api-v3-sdk/models/create_child'
@@ -60,6 +61,7 @@ require 'sib-api-v3-sdk/models/get_aggregated_report'
60
61
  require 'sib-api-v3-sdk/models/get_attributes'
61
62
  require 'sib-api-v3-sdk/models/get_attributes_attributes'
62
63
  require 'sib-api-v3-sdk/models/get_attributes_enumeration'
64
+ require 'sib-api-v3-sdk/models/get_blocked_domains'
63
65
  require 'sib-api-v3-sdk/models/get_campaign_overview'
64
66
  require 'sib-api-v3-sdk/models/get_campaign_recipients'
65
67
  require 'sib-api-v3-sdk/models/get_campaign_stats'
@@ -19,6 +19,16 @@ module SibApiV3Sdk
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+
23
+ # Set custom user_agent if explicitly passed in api
24
+ # default will still remain Swagger-Codegen/#{VERSION}/ruby
25
+ def setUserAgent(user_agent)
26
+ @user_agent = user_agent
27
+ if user_agent.is_a?(String) && user_agent.downcase.start_with?('sendinblue_')
28
+ @api_client.default_headers['User-Agent'] = @user_agent
29
+ end
30
+ end
31
+
22
32
  # Get your account information, plan and credits details
23
33
  # @param [Hash] opts the optional parameters
24
34
  # @return [GetAccount]
@@ -19,6 +19,16 @@ module SibApiV3Sdk
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+
23
+ # Set custom user_agent if explicitly passed in api
24
+ # default will still remain Swagger-Codegen/#{VERSION}/ruby
25
+ def setUserAgent(user_agent)
26
+ @user_agent = user_agent
27
+ if user_agent.is_a?(String) && user_agent.downcase.start_with?('sendinblue_')
28
+ @api_client.default_headers['User-Agent'] = @user_agent
29
+ end
30
+ end
31
+
22
32
  # Create contact attribute
23
33
  # @param attribute_category Category of the attribute
24
34
  # @param attribute_name Name of the attribute
@@ -19,6 +19,16 @@ module SibApiV3Sdk
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+
23
+ # Set custom user_agent if explicitly passed in api
24
+ # default will still remain Swagger-Codegen/#{VERSION}/ruby
25
+ def setUserAgent(user_agent)
26
+ @user_agent = user_agent
27
+ if user_agent.is_a?(String) && user_agent.downcase.start_with?('sendinblue_')
28
+ @api_client.default_headers['User-Agent'] = @user_agent
29
+ end
30
+ end
31
+
22
32
  # Add existing contacts to a list
23
33
  # @param list_id Id of the list
24
34
  # @param contact_emails Emails addresses OR IDs of the contacts
@@ -726,6 +736,7 @@ module SibApiV3Sdk
726
736
  # @option opts [Integer] :limit Number of documents per page (default to 50)
727
737
  # @option opts [Integer] :offset Index of the first document of the page (default to 0)
728
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)
729
740
  # @return [GetContacts]
730
741
  def get_contacts(opts = {})
731
742
  data, _status_code, _headers = get_contacts_with_http_info(opts)
@@ -737,6 +748,7 @@ module SibApiV3Sdk
737
748
  # @option opts [Integer] :limit Number of documents per page
738
749
  # @option opts [Integer] :offset Index of the first document of the page
739
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
740
752
  # @return [Array<(GetContacts, Fixnum, Hash)>] GetContacts data, response status code and response headers
741
753
  def get_contacts_with_http_info(opts = {})
742
754
  if @api_client.config.debugging
@@ -746,6 +758,9 @@ module SibApiV3Sdk
746
758
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactsApi.get_contacts, must be smaller than or equal to 1000.'
747
759
  end
748
760
 
761
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
762
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
763
+ end
749
764
  # resource path
750
765
  local_var_path = '/contacts'
751
766
 
@@ -754,6 +769,7 @@ module SibApiV3Sdk
754
769
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
755
770
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
756
771
  query_params[:'modifiedSince'] = opts[:'modified_since'] if !opts[:'modified_since'].nil?
772
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
757
773
 
758
774
  # header parameters
759
775
  header_params = {}
@@ -786,6 +802,7 @@ module SibApiV3Sdk
786
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.
787
803
  # @option opts [Integer] :limit Number of documents per page (default to 50)
788
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)
789
806
  # @return [GetContacts]
790
807
  def get_contacts_from_list(list_id, opts = {})
791
808
  data, _status_code, _headers = get_contacts_from_list_with_http_info(list_id, opts)
@@ -798,6 +815,7 @@ module SibApiV3Sdk
798
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.
799
816
  # @option opts [Integer] :limit Number of documents per page
800
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
801
819
  # @return [Array<(GetContacts, Fixnum, Hash)>] GetContacts data, response status code and response headers
802
820
  def get_contacts_from_list_with_http_info(list_id, opts = {})
803
821
  if @api_client.config.debugging
@@ -811,6 +829,9 @@ module SibApiV3Sdk
811
829
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactsApi.get_contacts_from_list, must be smaller than or equal to 500.'
812
830
  end
813
831
 
832
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
833
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
834
+ end
814
835
  # resource path
815
836
  local_var_path = '/contacts/lists/{listId}/contacts'.sub('{' + 'listId' + '}', list_id.to_s)
816
837
 
@@ -819,6 +840,7 @@ module SibApiV3Sdk
819
840
  query_params[:'modifiedSince'] = opts[:'modified_since'] if !opts[:'modified_since'].nil?
820
841
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
821
842
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
843
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
822
844
 
823
845
  # header parameters
824
846
  header_params = {}
@@ -902,6 +924,7 @@ module SibApiV3Sdk
902
924
  # @param [Hash] opts the optional parameters
903
925
  # @option opts [Integer] :limit Number of documents per page (default to 10)
904
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)
905
928
  # @return [GetFolderLists]
906
929
  def get_folder_lists(folder_id, opts = {})
907
930
  data, _status_code, _headers = get_folder_lists_with_http_info(folder_id, opts)
@@ -913,6 +936,7 @@ module SibApiV3Sdk
913
936
  # @param [Hash] opts the optional parameters
914
937
  # @option opts [Integer] :limit Number of documents per page
915
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
916
940
  # @return [Array<(GetFolderLists, Fixnum, Hash)>] GetFolderLists data, response status code and response headers
917
941
  def get_folder_lists_with_http_info(folder_id, opts = {})
918
942
  if @api_client.config.debugging
@@ -926,6 +950,9 @@ module SibApiV3Sdk
926
950
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactsApi.get_folder_lists, must be smaller than or equal to 50.'
927
951
  end
928
952
 
953
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
954
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
955
+ end
929
956
  # resource path
930
957
  local_var_path = '/contacts/folders/{folderId}/lists'.sub('{' + 'folderId' + '}', folder_id.to_s)
931
958
 
@@ -933,6 +960,7 @@ module SibApiV3Sdk
933
960
  query_params = {}
934
961
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
935
962
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
963
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
936
964
 
937
965
  # header parameters
938
966
  header_params = {}
@@ -963,6 +991,7 @@ module SibApiV3Sdk
963
991
  # @param limit Number of documents per page
964
992
  # @param offset Index of the first document of the page
965
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)
966
995
  # @return [GetFolders]
967
996
  def get_folders(limit, offset, opts = {})
968
997
  data, _status_code, _headers = get_folders_with_http_info(limit, offset, opts)
@@ -973,6 +1002,7 @@ module SibApiV3Sdk
973
1002
  # @param limit Number of documents per page
974
1003
  # @param offset Index of the first document of the page
975
1004
  # @param [Hash] opts the optional parameters
1005
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
976
1006
  # @return [Array<(GetFolders, Fixnum, Hash)>] GetFolders data, response status code and response headers
977
1007
  def get_folders_with_http_info(limit, offset, opts = {})
978
1008
  if @api_client.config.debugging
@@ -990,6 +1020,9 @@ module SibApiV3Sdk
990
1020
  if @api_client.config.client_side_validation && offset.nil?
991
1021
  fail ArgumentError, "Missing the required parameter 'offset' when calling ContactsApi.get_folders"
992
1022
  end
1023
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
1024
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
1025
+ end
993
1026
  # resource path
994
1027
  local_var_path = '/contacts/folders'
995
1028
 
@@ -997,6 +1030,7 @@ module SibApiV3Sdk
997
1030
  query_params = {}
998
1031
  query_params[:'limit'] = limit
999
1032
  query_params[:'offset'] = offset
1033
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1000
1034
 
1001
1035
  # header parameters
1002
1036
  header_params = {}
@@ -1079,6 +1113,7 @@ module SibApiV3Sdk
1079
1113
  # @param [Hash] opts the optional parameters
1080
1114
  # @option opts [Integer] :limit Number of documents per page (default to 10)
1081
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)
1082
1117
  # @return [GetLists]
1083
1118
  def get_lists(opts = {})
1084
1119
  data, _status_code, _headers = get_lists_with_http_info(opts)
@@ -1089,6 +1124,7 @@ module SibApiV3Sdk
1089
1124
  # @param [Hash] opts the optional parameters
1090
1125
  # @option opts [Integer] :limit Number of documents per page
1091
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
1092
1128
  # @return [Array<(GetLists, Fixnum, Hash)>] GetLists data, response status code and response headers
1093
1129
  def get_lists_with_http_info(opts = {})
1094
1130
  if @api_client.config.debugging
@@ -1098,6 +1134,9 @@ module SibApiV3Sdk
1098
1134
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactsApi.get_lists, must be smaller than or equal to 50.'
1099
1135
  end
1100
1136
 
1137
+ if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
1138
+ fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
1139
+ end
1101
1140
  # resource path
1102
1141
  local_var_path = '/contacts/lists'
1103
1142
 
@@ -1105,6 +1144,7 @@ module SibApiV3Sdk
1105
1144
  query_params = {}
1106
1145
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1107
1146
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
1147
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1108
1148
 
1109
1149
  # header parameters
1110
1150
  header_params = {}