Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Swagger updates for date format and some minor fixes #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aakanksha-sib merged 1 commit into from
Mar 19, 2019
Merged

Swagger updates for date format and some minor fixes #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions 4 docs/DeleteHardbounces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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]
**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]
**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]
**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]
**contact_email** | **str** | Target a specific email address | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
6 changes: 2 additions & 4 deletions 6 docs/SMSCampaignsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ void (empty response body)
[[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)

# **get_sms_campaign**
> GetSmsCampaign get_sms_campaign(campaign_id, get_sms_campaign)
> GetSmsCampaign get_sms_campaign(campaign_id)

Get an SMS campaign

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

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

### Return type

Expand Down
24 changes: 12 additions & 12 deletions 24 docs/SMTPApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,8 +215,8 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = sib_api_v3_sdk.SMTPApi(sib_api_v3_sdk.ApiClient(configuration))
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)
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)
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)
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)
days = 56 # int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)
tag = 'tag_example' # str | Tag of the emails (optional)

Expand All @@ -232,8 +232,8 @@ except ApiException as e:

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

Expand Down Expand Up @@ -280,8 +280,8 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
api_instance = sib_api_v3_sdk.SMTPApi(sib_api_v3_sdk.ApiClient(configuration))
limit = 50 # int | Number limitation for the result returned (optional) (default to 50)
offset = 0 # int | Beginning point in the list to retrieve from. (optional) (default to 0)
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)
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)
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)
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)
days = 56 # int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)
email = 'email_example' # str | Filter the report for a specific email addresses (optional)
event = 'event_example' # str | Filter the report for a specific event type (optional)
Expand All @@ -303,8 +303,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **int**| Number limitation for the result returned | [optional] [default to 50]
**offset** | **int**| Beginning point in the list to retrieve from. | [optional] [default to 0]
**start_date** | **date**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
**end_date** | **date**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
**start_date** | **str**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
**end_date** | **str**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
**days** | **int**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
**email** | **str**| Filter the report for a specific email addresses | [optional]
**event** | **str**| Filter the report for a specific event type | [optional]
Expand Down Expand Up @@ -355,8 +355,8 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
api_instance = sib_api_v3_sdk.SMTPApi(sib_api_v3_sdk.ApiClient(configuration))
limit = 50 # int | Number of documents returned per page (optional) (default to 50)
offset = 0 # int | Index of the first document on the page (optional) (default to 0)
start_date = '2013-10-20' # date | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) (optional)
end_date = '2013-10-20' # date | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) (optional)
start_date = 'start_date_example' # str | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) (optional)
end_date = 'end_date_example' # str | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) (optional)
days = 56 # int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)
tag = 'tag_example' # str | Tag of the emails (optional)

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

Expand Down
24 changes: 12 additions & 12 deletions 24 docs/TransactionalSMSApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# create an instance of the API class
api_instance = sib_api_v3_sdk.TransactionalSMSApi(sib_api_v3_sdk.ApiClient(configuration))
limit = 50 # int | Number of documents per page (optional) (default to 50)
start_date = '2013-10-20' # date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
end_date = '2013-10-20' # date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
start_date = 'start_date_example' # str | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
end_date = 'end_date_example' # str | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
offset = 0 # int | Index of the first document of the page (optional) (default to 0)
days = 56 # int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)
phone_number = 'phone_number_example' # str | Filter the report for a specific phone number (optional)
Expand All @@ -58,8 +58,8 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **int**| Number of documents per page | [optional] [default to 50]
**start_date** | **date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
**end_date** | **date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
**start_date** | **str**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
**end_date** | **str**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
**days** | **int**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
**phone_number** | **str**| Filter the report for a specific phone number | [optional]
Expand Down Expand Up @@ -107,8 +107,8 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'

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

Expand All @@ -124,8 +124,8 @@ except ApiException as e:

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

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

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

Expand All @@ -187,8 +187,8 @@ except ApiException as e:

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

Expand Down
2 changes: 1 addition & 1 deletion 2 setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
from setuptools import setup, find_packages

NAME = "sib-api-v3-sdk"
VERSION = "4.2.1"
VERSION = "4.2.2"
# To install the library, run the following
#
# python setup.py install
Expand Down
22 changes: 7 additions & 15 deletions 22 sib_api_v3_sdk/api/sms_campaigns_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,45 +227,43 @@ def delete_sms_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E5
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)

def get_sms_campaign(self, campaign_id, get_sms_campaign, **kwargs): # noqa: E501
def get_sms_campaign(self, campaign_id, **kwargs): # noqa: E501
"""Get an SMS campaign # noqa: E501

This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_sms_campaign(campaign_id, get_sms_campaign, async=True)
>>> thread = api.get_sms_campaign(campaign_id, async=True)
>>> result = thread.get()

:param async bool
:param int campaign_id: id of the SMS campaign (required)
:param GetSmsCampaign get_sms_campaign: Values to update an SMS Campaign (required)
:return: GetSmsCampaign
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async'):
return self.get_sms_campaign_with_http_info(campaign_id, get_sms_campaign, **kwargs) # noqa: E501
return self.get_sms_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_sms_campaign_with_http_info(campaign_id, get_sms_campaign, **kwargs) # noqa: E501
(data) = self.get_sms_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data

def get_sms_campaign_with_http_info(self, campaign_id, get_sms_campaign, **kwargs): # noqa: E501
def get_sms_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""Get an SMS campaign # noqa: E501

This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_sms_campaign_with_http_info(campaign_id, get_sms_campaign, async=True)
>>> thread = api.get_sms_campaign_with_http_info(campaign_id, async=True)
>>> result = thread.get()

:param async bool
:param int campaign_id: id of the SMS campaign (required)
:param GetSmsCampaign get_sms_campaign: Values to update an SMS Campaign (required)
:return: GetSmsCampaign
If the method is called asynchronously,
returns the request thread.
"""

all_params = ['campaign_id', 'get_sms_campaign'] # noqa: E501
all_params = ['campaign_id'] # noqa: E501
all_params.append('async')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
Expand All @@ -284,10 +282,6 @@ def get_sms_campaign_with_http_info(self, campaign_id, get_sms_campaign, **kwarg
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling `get_sms_campaign`") # noqa: E501
# verify the required parameter 'get_sms_campaign' is set
if ('get_sms_campaign' not in params or
params['get_sms_campaign'] is None):
raise ValueError("Missing the required parameter `get_sms_campaign` when calling `get_sms_campaign`") # noqa: E501

collection_formats = {}

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

body_params = None
if 'get_sms_campaign' in params:
body_params = params['get_sms_campaign']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
Expand Down
Loading
Morty Proxy This is a proxified and sanitized view of the page, visit original site.