Skip to content

Commit 0d4e704

Browse files
Merge pull request #58 from sendinblue/feature_AP_1446
AP-1446 : Latest swagger updates
2 parents 96e581a + 30e8996 commit 0d4e704

File tree

408 files changed

+522
-435
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

408 files changed

+522
-435
lines changed

.swagger-codegen/VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2.4.18
1+
2.4.19

docs/ContactsApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -744,8 +744,8 @@ api_instance = SibApiV3Sdk::ContactsApi.new
744744
identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact
745745

746746
opts = {
747-
start_date: Date.parse('2013-10-20'), # Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
748-
end_date: Date.parse('2013-10-20') # Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
747+
start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
748+
end_date: 'end_date_example' # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
749749
}
750750

751751
begin
@@ -762,8 +762,8 @@ end
762762
Name | Type | Description | Notes
763763
------------- | ------------- | ------------- | -------------
764764
**identifier** | **String**| Email (urlencoded) OR ID of the contact |
765-
**start_date** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional]
766-
**end_date** | **Date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate | [optional]
765+
**start_date** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional]
766+
**end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate | [optional]
767767

768768
### Return type
769769

docs/GetExtendedList.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
77
**name** | **String** | Name of the list |
88
**total_blacklisted** | **Integer** | Number of blacklisted contacts in the list |
99
**total_subscribers** | **Integer** | Number of contacts in the list |
10+
**unique_subscribers** | **Integer** | Number of unique contacts in the list |
1011
**folder_id** | **Integer** | ID of the folder |
1112
**created_at** | **String** | Creation UTC date-time of the list (YYYY-MM-DDTHH:mm:ss.SSSZ) |
1213
**campaign_stats** | [**Array<GetExtendedListCampaignStats>**](GetExtendedListCampaignStats.md) | | [optional]

docs/GetList.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ Name | Type | Description | Notes
77
**name** | **String** | Name of the list |
88
**total_blacklisted** | **Integer** | Number of blacklisted contacts in the list |
99
**total_subscribers** | **Integer** | Number of contacts in the list |
10+
**unique_subscribers** | **Integer** | Number of unique contacts in the list |
1011

1112

docs/GetTransacEmailsList.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6+
**count** | **Integer** | Total number of transactional emails available on your account according to the passed filter | [optional]
67
**transactional_emails** | [**Array<GetTransacEmailsListTransactionalEmails>**](GetTransacEmailsListTransactionalEmails.md) | | [optional]
78

89

docs/SendTestEmail.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**email_to** | **Array<String>** | List of the email addresses of the recipients whom you wish to send the test mail. If left empty, the test mail will be sent to your entire test list. | [optional]
6+
**email_to** | **Array<String>** | List of the email addresses of the recipients whom you wish to send the test mail. If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day. | [optional]
77

88

docs/TransactionalEmailsApi.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -855,9 +855,11 @@ opts = {
855855
email: 'email_example', # String | Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
856856
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.
857857
message_id: 'message_id_example', # String | Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
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.
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. Default order is **descending** if `sort` is not passed
858+
start_date: 'start_date_example', # String | 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.
859+
end_date: 'end_date_example', # String | 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. Default order is **descending** if `sort` is not passed
861+
limit: 500, # Integer | Number of documents returned per page
862+
offset: 0 # Integer | Index of the first document in the page
861863
}
862864

863865
begin
@@ -876,9 +878,11 @@ Name | Type | Description | Notes
876878
**email** | **String**| Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. | [optional]
877879
**template_id** | **Integer**| Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. | [optional]
878880
**message_id** | **String**| Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. | [optional]
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]
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+
**start_date** | **String**| 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]
882+
**end_date** | **String**| 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]
881883
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
884+
**limit** | **Integer**| Number of documents returned per page | [optional] [default to 500]
885+
**offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
882886

883887
### Return type
884888

docs/WebhooksApi.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,8 @@ end
206206
api_instance = SibApiV3Sdk::WebhooksApi.new
207207

208208
opts = {
209-
type: 'transactional' # String | Filter on webhook type
209+
type: 'transactional', # String | Filter on webhook type
210+
sort: 'desc' # String | Sort the results in the ascending/descending order of webhook creation
210211
}
211212

212213
begin
@@ -223,6 +224,7 @@ end
223224
Name | Type | Description | Notes
224225
------------- | ------------- | ------------- | -------------
225226
**type** | **String**| Filter on webhook type | [optional] [default to transactional]
227+
**sort** | **String**| Sort the results in the ascending/descending order of webhook creation | [optional] [default to desc]
226228

227229
### Return type
228230

lib/sib-api-v3-sdk.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
OpenAPI spec version: 3.0.0
77
Contact: contact@sendinblue.com
88
Generated by: https://github.com/swagger-api/swagger-codegen.git
9-
Swagger Codegen version: 2.4.18
9+
Swagger Codegen version: 2.4.19
1010
1111
=end
1212

lib/sib-api-v3-sdk/api/account_api.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
OpenAPI spec version: 3.0.0
77
Contact: contact@sendinblue.com
88
Generated by: https://github.com/swagger-api/swagger-codegen.git
9-
Swagger Codegen version: 2.4.18
9+
Swagger Codegen version: 2.4.19
1010
1111
=end
1212

lib/sib-api-v3-sdk/api/attributes_api.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
OpenAPI spec version: 3.0.0
77
Contact: contact@sendinblue.com
88
Generated by: https://github.com/swagger-api/swagger-codegen.git
9-
Swagger Codegen version: 2.4.18
9+
Swagger Codegen version: 2.4.19
1010
1111
=end
1212

lib/sib-api-v3-sdk/api/contacts_api.rb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
OpenAPI spec version: 3.0.0
77
Contact: contact@sendinblue.com
88
Generated by: https://github.com/swagger-api/swagger-codegen.git
9-
Swagger Codegen version: 2.4.18
9+
Swagger Codegen version: 2.4.19
1010
1111
=end
1212

@@ -676,8 +676,8 @@ def get_contact_info_with_http_info(identifier, opts = {})
676676
# Get email campaigns' statistics for a contact
677677
# @param identifier Email (urlencoded) OR ID of the contact
678678
# @param [Hash] opts the optional parameters
679-
# @option opts [Date] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
680-
# @option opts [Date] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
679+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
680+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
681681
# @return [GetContactCampaignStats]
682682
def get_contact_stats(identifier, opts = {})
683683
data, _status_code, _headers = get_contact_stats_with_http_info(identifier, opts)
@@ -687,8 +687,8 @@ def get_contact_stats(identifier, opts = {})
687687
# Get email campaigns' statistics for a contact
688688
# @param identifier Email (urlencoded) OR ID of the contact
689689
# @param [Hash] opts the optional parameters
690-
# @option opts [Date] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
691-
# @option opts [Date] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
690+
# @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
691+
# @option opts [String] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
692692
# @return [Array<(GetContactCampaignStats, Fixnum, Hash)>] GetContactCampaignStats data, response status code and response headers
693693
def get_contact_stats_with_http_info(identifier, opts = {})
694694
if @api_client.config.debugging

lib/sib-api-v3-sdk/api/email_campaigns_api.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
OpenAPI spec version: 3.0.0
77
Contact: contact@sendinblue.com
88
Generated by: https://github.com/swagger-api/swagger-codegen.git
9-
Swagger Codegen version: 2.4.18
9+
Swagger Codegen version: 2.4.19
1010
1111
=end
1212

lib/sib-api-v3-sdk/api/folders_api.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
OpenAPI spec version: 3.0.0
77
Contact: contact@sendinblue.com
88
Generated by: https://github.com/swagger-api/swagger-codegen.git
9-
Swagger Codegen version: 2.4.18
9+
Swagger Codegen version: 2.4.19
1010
1111
=end
1212

lib/sib-api-v3-sdk/api/lists_api.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
OpenAPI spec version: 3.0.0
77
Contact: contact@sendinblue.com
88
Generated by: https://github.com/swagger-api/swagger-codegen.git
9-
Swagger Codegen version: 2.4.18
9+
Swagger Codegen version: 2.4.19
1010
1111
=end
1212

lib/sib-api-v3-sdk/api/process_api.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
OpenAPI spec version: 3.0.0
77
Contact: contact@sendinblue.com
88
Generated by: https://github.com/swagger-api/swagger-codegen.git
9-
Swagger Codegen version: 2.4.18
9+
Swagger Codegen version: 2.4.19
1010
1111
=end
1212

lib/sib-api-v3-sdk/api/reseller_api.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
OpenAPI spec version: 3.0.0
77
Contact: contact@sendinblue.com
88
Generated by: https://github.com/swagger-api/swagger-codegen.git
9-
Swagger Codegen version: 2.4.18
9+
Swagger Codegen version: 2.4.19
1010
1111
=end
1212

lib/sib-api-v3-sdk/api/senders_api.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
OpenAPI spec version: 3.0.0
77
Contact: contact@sendinblue.com
88
Generated by: https://github.com/swagger-api/swagger-codegen.git
9-
Swagger Codegen version: 2.4.18
9+
Swagger Codegen version: 2.4.19
1010
1111
=end
1212

lib/sib-api-v3-sdk/api/sms_campaigns_api.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
OpenAPI spec version: 3.0.0
77
Contact: contact@sendinblue.com
88
Generated by: https://github.com/swagger-api/swagger-codegen.git
9-
Swagger Codegen version: 2.4.18
9+
Swagger Codegen version: 2.4.19
1010
1111
=end
1212

lib/sib-api-v3-sdk/api/transactional_emails_api.rb

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
OpenAPI spec version: 3.0.0
77
Contact: contact@sendinblue.com
88
Generated by: https://github.com/swagger-api/swagger-codegen.git
9-
Swagger Codegen version: 2.4.18
9+
Swagger Codegen version: 2.4.19
1010
1111
=end
1212

@@ -802,9 +802,11 @@ def get_transac_email_content_with_http_info(uuid, opts = {})
802802
# @option opts [String] :email Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
803803
# @option opts [Integer] :template_id Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
804804
# @option opts [String] :message_id Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
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-
# @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.
805+
# @option opts [String] :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+
# @option opts [String] :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.
807807
# @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+
# @option opts [Integer] :limit Number of documents returned per page (default to 500)
809+
# @option opts [Integer] :offset Index of the first document in the page (default to 0)
808810
# @return [GetTransacEmailsList]
809811
def get_transac_emails_list(opts = {})
810812
data, _status_code, _headers = get_transac_emails_list_with_http_info(opts)
@@ -817,9 +819,11 @@ def get_transac_emails_list(opts = {})
817819
# @option opts [String] :email Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
818820
# @option opts [Integer] :template_id Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
819821
# @option opts [String] :message_id Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
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-
# @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] :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.
823+
# @option opts [String] :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.
822824
# @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
825+
# @option opts [Integer] :limit Number of documents returned per page
826+
# @option opts [Integer] :offset Index of the first document in the page
823827
# @return [Array<(GetTransacEmailsList, Fixnum, Hash)>] GetTransacEmailsList data, response status code and response headers
824828
def get_transac_emails_list_with_http_info(opts = {})
825829
if @api_client.config.debugging
@@ -828,6 +832,10 @@ def get_transac_emails_list_with_http_info(opts = {})
828832
if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
829833
fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
830834
end
835+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
836+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_transac_emails_list, must be smaller than or equal to 1000.'
837+
end
838+
831839
# resource path
832840
local_var_path = '/smtp/emails'
833841

@@ -839,6 +847,8 @@ def get_transac_emails_list_with_http_info(opts = {})
839847
query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
840848
query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
841849
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
850+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
851+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
842852

843853
# header parameters
844854
header_params = {}

lib/sib-api-v3-sdk/api/transactional_sms_api.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
OpenAPI spec version: 3.0.0
77
Contact: contact@sendinblue.com
88
Generated by: https://github.com/swagger-api/swagger-codegen.git
9-
Swagger Codegen version: 2.4.18
9+
Swagger Codegen version: 2.4.19
1010
1111
=end
1212

lib/sib-api-v3-sdk/api/webhooks_api.rb

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
OpenAPI spec version: 3.0.0
77
Contact: contact@sendinblue.com
88
Generated by: https://github.com/swagger-api/swagger-codegen.git
9-
Swagger Codegen version: 2.4.18
9+
Swagger Codegen version: 2.4.19
1010
1111
=end
1212

@@ -187,6 +187,7 @@ def get_webhook_with_http_info(webhook_id, opts = {})
187187
# Get all webhooks
188188
# @param [Hash] opts the optional parameters
189189
# @option opts [String] :type Filter on webhook type (default to transactional)
190+
# @option opts [String] :sort Sort the results in the ascending/descending order of webhook creation (default to desc)
190191
# @return [GetWebhooks]
191192
def get_webhooks(opts = {})
192193
data, _status_code, _headers = get_webhooks_with_http_info(opts)
@@ -196,6 +197,7 @@ def get_webhooks(opts = {})
196197
# Get all webhooks
197198
# @param [Hash] opts the optional parameters
198199
# @option opts [String] :type Filter on webhook type
200+
# @option opts [String] :sort Sort the results in the ascending/descending order of webhook creation
199201
# @return [Array<(GetWebhooks, Fixnum, Hash)>] GetWebhooks data, response status code and response headers
200202
def get_webhooks_with_http_info(opts = {})
201203
if @api_client.config.debugging
@@ -204,12 +206,16 @@ def get_webhooks_with_http_info(opts = {})
204206
if @api_client.config.client_side_validation && opts[:'type'] && !['marketing', 'transactional'].include?(opts[:'type'])
205207
fail ArgumentError, 'invalid value for "type", must be one of marketing, transactional'
206208
end
209+
if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
210+
fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
211+
end
207212
# resource path
208213
local_var_path = '/webhooks'
209214

210215
# query parameters
211216
query_params = {}
212217
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
218+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
213219

214220
# header parameters
215221
header_params = {}

0 commit comments

Comments
 (0)