Skip to content

Commit 63e8f46

Browse files
Merge pull request #30 from sendinblue/feature_updated_swagger_sync
Swagger updates for date format and some minor fixes
2 parents 5e29d22 + 9eb29ac commit 63e8f46

10 files changed

+67
-77
lines changed

docs/DeleteHardbounces.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**start_date** | **date** | Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate | [optional]
7-
**end_date** | **date** | Ending date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate | [optional]
6+
**start_date** | **str** | Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate | [optional]
7+
**end_date** | **str** | Ending date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate | [optional]
88
**contact_email** | **str** | Target a specific email address | [optional]
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/SMSCampaignsApi.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ void (empty response body)
130130
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
131131

132132
# **get_sms_campaign**
133-
> GetSmsCampaign get_sms_campaign(campaign_id, get_sms_campaign)
133+
> GetSmsCampaign get_sms_campaign(campaign_id)
134134
135135
Get an SMS campaign
136136

@@ -156,11 +156,10 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
156156
# create an instance of the API class
157157
api_instance = sib_api_v3_sdk.SMSCampaignsApi(sib_api_v3_sdk.ApiClient(configuration))
158158
campaign_id = 789 # int | id of the SMS campaign
159-
get_sms_campaign = sib_api_v3_sdk.GetSmsCampaign() # GetSmsCampaign | Values to update an SMS Campaign
160159

161160
try:
162161
# Get an SMS campaign
163-
api_response = api_instance.get_sms_campaign(campaign_id, get_sms_campaign)
162+
api_response = api_instance.get_sms_campaign(campaign_id)
164163
pprint(api_response)
165164
except ApiException as e:
166165
print("Exception when calling SMSCampaignsApi->get_sms_campaign: %s\n" % e)
@@ -171,7 +170,6 @@ except ApiException as e:
171170
Name | Type | Description | Notes
172171
------------- | ------------- | ------------- | -------------
173172
**campaign_id** | **int**| id of the SMS campaign |
174-
**get_sms_campaign** | [**GetSmsCampaign**](GetSmsCampaign.md)| Values to update an SMS Campaign |
175173

176174
### Return type
177175

docs/SMTPApi.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -215,8 +215,8 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
215215

216216
# create an instance of the API class
217217
api_instance = sib_api_v3_sdk.SMTPApi(sib_api_v3_sdk.ApiClient(configuration))
218-
start_date = '2013-10-20' # date | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional)
219-
end_date = '2013-10-20' # date | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional)
218+
start_date = 'start_date_example' # str | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional)
219+
end_date = 'end_date_example' # str | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional)
220220
days = 56 # int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)
221221
tag = 'tag_example' # str | Tag of the emails (optional)
222222

@@ -232,8 +232,8 @@ except ApiException as e:
232232

233233
Name | Type | Description | Notes
234234
------------- | ------------- | ------------- | -------------
235-
**start_date** | **date**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
236-
**end_date** | **date**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
235+
**start_date** | **str**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
236+
**end_date** | **str**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
237237
**days** | **int**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
238238
**tag** | **str**| Tag of the emails | [optional]
239239

@@ -280,8 +280,8 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
280280
api_instance = sib_api_v3_sdk.SMTPApi(sib_api_v3_sdk.ApiClient(configuration))
281281
limit = 50 # int | Number limitation for the result returned (optional) (default to 50)
282282
offset = 0 # int | Beginning point in the list to retrieve from. (optional) (default to 0)
283-
start_date = '2013-10-20' # date | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional)
284-
end_date = '2013-10-20' # date | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional)
283+
start_date = 'start_date_example' # str | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional)
284+
end_date = 'end_date_example' # str | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional)
285285
days = 56 # int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)
286286
email = 'email_example' # str | Filter the report for a specific email addresses (optional)
287287
event = 'event_example' # str | Filter the report for a specific event type (optional)
@@ -303,8 +303,8 @@ Name | Type | Description | Notes
303303
------------- | ------------- | ------------- | -------------
304304
**limit** | **int**| Number limitation for the result returned | [optional] [default to 50]
305305
**offset** | **int**| Beginning point in the list to retrieve from. | [optional] [default to 0]
306-
**start_date** | **date**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
307-
**end_date** | **date**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
306+
**start_date** | **str**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
307+
**end_date** | **str**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
308308
**days** | **int**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
309309
**email** | **str**| Filter the report for a specific email addresses | [optional]
310310
**event** | **str**| Filter the report for a specific event type | [optional]
@@ -355,8 +355,8 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
355355
api_instance = sib_api_v3_sdk.SMTPApi(sib_api_v3_sdk.ApiClient(configuration))
356356
limit = 50 # int | Number of documents returned per page (optional) (default to 50)
357357
offset = 0 # int | Index of the first document on the page (optional) (default to 0)
358-
start_date = '2013-10-20' # date | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) (optional)
359-
end_date = '2013-10-20' # date | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) (optional)
358+
start_date = 'start_date_example' # str | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) (optional)
359+
end_date = 'end_date_example' # str | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) (optional)
360360
days = 56 # int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)
361361
tag = 'tag_example' # str | Tag of the emails (optional)
362362

@@ -374,8 +374,8 @@ Name | Type | Description | Notes
374374
------------- | ------------- | ------------- | -------------
375375
**limit** | **int**| Number of documents returned per page | [optional] [default to 50]
376376
**offset** | **int**| Index of the first document on the page | [optional] [default to 0]
377-
**start_date** | **date**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) | [optional]
378-
**end_date** | **date**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional]
377+
**start_date** | **str**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) | [optional]
378+
**end_date** | **str**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional]
379379
**days** | **int**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
380380
**tag** | **str**| Tag of the emails | [optional]
381381

docs/TransactionalSMSApi.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
3737
# create an instance of the API class
3838
api_instance = sib_api_v3_sdk.TransactionalSMSApi(sib_api_v3_sdk.ApiClient(configuration))
3939
limit = 50 # int | Number of documents per page (optional) (default to 50)
40-
start_date = '2013-10-20' # date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
41-
end_date = '2013-10-20' # date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
40+
start_date = 'start_date_example' # str | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
41+
end_date = 'end_date_example' # str | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
4242
offset = 0 # int | Index of the first document of the page (optional) (default to 0)
4343
days = 56 # int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)
4444
phone_number = 'phone_number_example' # str | Filter the report for a specific phone number (optional)
@@ -58,8 +58,8 @@ except ApiException as e:
5858
Name | Type | Description | Notes
5959
------------- | ------------- | ------------- | -------------
6060
**limit** | **int**| Number of documents per page | [optional] [default to 50]
61-
**start_date** | **date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
62-
**end_date** | **date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
61+
**start_date** | **str**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
62+
**end_date** | **str**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
6363
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
6464
**days** | **int**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
6565
**phone_number** | **str**| Filter the report for a specific phone number | [optional]
@@ -107,8 +107,8 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
107107

108108
# create an instance of the API class
109109
api_instance = sib_api_v3_sdk.TransactionalSMSApi(sib_api_v3_sdk.ApiClient(configuration))
110-
start_date = '2013-10-20' # date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
111-
end_date = '2013-10-20' # date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
110+
start_date = 'start_date_example' # str | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
111+
end_date = 'end_date_example' # str | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
112112
days = 56 # int | Number of days in the past including today (positive integer). Not compatible with startDate and endDate (optional)
113113
tag = 'tag_example' # str | Filter on a tag (optional)
114114

@@ -124,8 +124,8 @@ except ApiException as e:
124124

125125
Name | Type | Description | Notes
126126
------------- | ------------- | ------------- | -------------
127-
**start_date** | **date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
128-
**end_date** | **date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
127+
**start_date** | **str**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
128+
**end_date** | **str**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
129129
**days** | **int**| Number of days in the past including today (positive integer). Not compatible with startDate and endDate | [optional]
130130
**tag** | **str**| Filter on a tag | [optional]
131131

@@ -170,8 +170,8 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
170170

171171
# create an instance of the API class
172172
api_instance = sib_api_v3_sdk.TransactionalSMSApi(sib_api_v3_sdk.ApiClient(configuration))
173-
start_date = '2013-10-20' # date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
174-
end_date = '2013-10-20' # date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
173+
start_date = 'start_date_example' # str | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
174+
end_date = 'end_date_example' # str | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
175175
days = 56 # int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)
176176
tag = 'tag_example' # str | Filter on a tag (optional)
177177

@@ -187,8 +187,8 @@ except ApiException as e:
187187

188188
Name | Type | Description | Notes
189189
------------- | ------------- | ------------- | -------------
190-
**start_date** | **date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
191-
**end_date** | **date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
190+
**start_date** | **str**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
191+
**end_date** | **str**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
192192
**days** | **int**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
193193
**tag** | **str**| Filter on a tag | [optional]
194194

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
from setuptools import setup, find_packages
1616

1717
NAME = "sib-api-v3-sdk"
18-
VERSION = "4.2.1"
18+
VERSION = "4.2.2"
1919
# To install the library, run the following
2020
#
2121
# python setup.py install

sib_api_v3_sdk/api/sms_campaigns_api.py

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -227,45 +227,43 @@ def delete_sms_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E5
227227
_request_timeout=params.get('_request_timeout'),
228228
collection_formats=collection_formats)
229229

230-
def get_sms_campaign(self, campaign_id, get_sms_campaign, **kwargs): # noqa: E501
230+
def get_sms_campaign(self, campaign_id, **kwargs): # noqa: E501
231231
"""Get an SMS campaign # noqa: E501
232232
233233
This method makes a synchronous HTTP request by default. To make an
234234
asynchronous HTTP request, please pass async=True
235-
>>> thread = api.get_sms_campaign(campaign_id, get_sms_campaign, async=True)
235+
>>> thread = api.get_sms_campaign(campaign_id, async=True)
236236
>>> result = thread.get()
237237
238238
:param async bool
239239
:param int campaign_id: id of the SMS campaign (required)
240-
:param GetSmsCampaign get_sms_campaign: Values to update an SMS Campaign (required)
241240
:return: GetSmsCampaign
242241
If the method is called asynchronously,
243242
returns the request thread.
244243
"""
245244
kwargs['_return_http_data_only'] = True
246245
if kwargs.get('async'):
247-
return self.get_sms_campaign_with_http_info(campaign_id, get_sms_campaign, **kwargs) # noqa: E501
246+
return self.get_sms_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
248247
else:
249-
(data) = self.get_sms_campaign_with_http_info(campaign_id, get_sms_campaign, **kwargs) # noqa: E501
248+
(data) = self.get_sms_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
250249
return data
251250

252-
def get_sms_campaign_with_http_info(self, campaign_id, get_sms_campaign, **kwargs): # noqa: E501
251+
def get_sms_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
253252
"""Get an SMS campaign # noqa: E501
254253
255254
This method makes a synchronous HTTP request by default. To make an
256255
asynchronous HTTP request, please pass async=True
257-
>>> thread = api.get_sms_campaign_with_http_info(campaign_id, get_sms_campaign, async=True)
256+
>>> thread = api.get_sms_campaign_with_http_info(campaign_id, async=True)
258257
>>> result = thread.get()
259258
260259
:param async bool
261260
:param int campaign_id: id of the SMS campaign (required)
262-
:param GetSmsCampaign get_sms_campaign: Values to update an SMS Campaign (required)
263261
:return: GetSmsCampaign
264262
If the method is called asynchronously,
265263
returns the request thread.
266264
"""
267265

268-
all_params = ['campaign_id', 'get_sms_campaign'] # noqa: E501
266+
all_params = ['campaign_id'] # noqa: E501
269267
all_params.append('async')
270268
all_params.append('_return_http_data_only')
271269
all_params.append('_preload_content')
@@ -284,10 +282,6 @@ def get_sms_campaign_with_http_info(self, campaign_id, get_sms_campaign, **kwarg
284282
if ('campaign_id' not in params or
285283
params['campaign_id'] is None):
286284
raise ValueError("Missing the required parameter `campaign_id` when calling `get_sms_campaign`") # noqa: E501
287-
# verify the required parameter 'get_sms_campaign' is set
288-
if ('get_sms_campaign' not in params or
289-
params['get_sms_campaign'] is None):
290-
raise ValueError("Missing the required parameter `get_sms_campaign` when calling `get_sms_campaign`") # noqa: E501
291285

292286
collection_formats = {}
293287

@@ -303,8 +297,6 @@ def get_sms_campaign_with_http_info(self, campaign_id, get_sms_campaign, **kwarg
303297
local_var_files = {}
304298

305299
body_params = None
306-
if 'get_sms_campaign' in params:
307-
body_params = params['get_sms_campaign']
308300
# HTTP header `Accept`
309301
header_params['Accept'] = self.api_client.select_header_accept(
310302
['application/json']) # noqa: E501

0 commit comments

Comments
 (0)