| Server IP : 209.209.40.120 / Your IP : 216.73.217.112 Web Server : Microsoft-IIS/10.0 System : Windows NT NEWWWW 10.0 build 17763 (Windows Server 2019) i586 User : NEWWWW$ ( 0) PHP Version : 8.3.30 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : OFF | Perl : OFF | Python : OFF | Sudo : OFF | Pkexec : OFF Directory : C:/Python312/Lib/site-packages/clicksend_client/api/ |
Upload File : |
# coding: utf-8
"""
ClickSend v3 API
This is an official SDK for [ClickSend](https://clicksend.com) Below you will find a current list of the available methods for clicksend. *NOTE: You will need to create a free account to use the API. You can register [here](https://dashboard.clicksend.com/#/signup/step1/)..* # noqa: E501
OpenAPI spec version: 3.1
Contact: support@clicksend.com
Generated by: https://github.com/clicksend-api/clicksend-codegen.git
"""
from __future__ import absolute_import
import re # noqa: F401
# python 2 and python 3 compatibility library
import six
from clicksend_client.api_client import ApiClient
class SMSApi(object):
"""NOTE: This class is auto generated by the clicksend code generator program.
Do not edit the class manually.
Ref: https://github.com/clicksend-api/clicksend-codegen
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
def sms_cancel_all_put(self, **kwargs): # noqa: E501
"""Update all scheduled message as cancelled # noqa: E501
Update all scheduled message as cancelled # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_cancel_all_put(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.sms_cancel_all_put_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.sms_cancel_all_put_with_http_info(**kwargs) # noqa: E501
return data
def sms_cancel_all_put_with_http_info(self, **kwargs): # noqa: E501
"""Update all scheduled message as cancelled # noqa: E501
Update all scheduled message as cancelled # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_cancel_all_put_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: str
If the method is called asynchronously,
returns the request thread.
"""
all_params = [] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method sms_cancel_all_put" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth'] # noqa: E501
return self.api_client.call_api(
'/sms/cancel-all', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def sms_cancel_by_message_id_put(self, message_id, **kwargs): # noqa: E501
"""Update scheduled message as cancelled # noqa: E501
Update scheduled message as cancelled # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_cancel_by_message_id_put(message_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str message_id: The message ID you want to cancel (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.sms_cancel_by_message_id_put_with_http_info(message_id, **kwargs) # noqa: E501
else:
(data) = self.sms_cancel_by_message_id_put_with_http_info(message_id, **kwargs) # noqa: E501
return data
def sms_cancel_by_message_id_put_with_http_info(self, message_id, **kwargs): # noqa: E501
"""Update scheduled message as cancelled # noqa: E501
Update scheduled message as cancelled # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_cancel_by_message_id_put_with_http_info(message_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str message_id: The message ID you want to cancel (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['message_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method sms_cancel_by_message_id_put" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'message_id' is set
if self.api_client.client_side_validation and ('message_id' not in params or
params['message_id'] is None): # noqa: E501
raise ValueError("Missing the required parameter `message_id` when calling `sms_cancel_by_message_id_put`") # noqa: E501
collection_formats = {}
path_params = {}
if 'message_id' in params:
path_params['message_id'] = params['message_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth'] # noqa: E501
return self.api_client.call_api(
'/sms/{message_id}/cancel', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def sms_history_export_get(self, filename, **kwargs): # noqa: E501
"""Export all sms history # noqa: E501
Export all sms history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_history_export_get(filename, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str filename: Filename to download history as (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.sms_history_export_get_with_http_info(filename, **kwargs) # noqa: E501
else:
(data) = self.sms_history_export_get_with_http_info(filename, **kwargs) # noqa: E501
return data
def sms_history_export_get_with_http_info(self, filename, **kwargs): # noqa: E501
"""Export all sms history # noqa: E501
Export all sms history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_history_export_get_with_http_info(filename, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str filename: Filename to download history as (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['filename'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method sms_history_export_get" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'filename' is set
if self.api_client.client_side_validation and ('filename' not in params or
params['filename'] is None): # noqa: E501
raise ValueError("Missing the required parameter `filename` when calling `sms_history_export_get`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'filename' in params:
query_params.append(('filename', params['filename'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth'] # noqa: E501
return self.api_client.call_api(
'/sms/history/export', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def sms_history_get(self, **kwargs): # noqa: E501
"""Get all sms history # noqa: E501
Get all sms history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_history_get(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str q: Custom query Example: from:{number},status_code:201.
:param int date_from: Start date
:param int date_to: End date
:param int page: Page number
:param int limit: Number of records per page
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.sms_history_get_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.sms_history_get_with_http_info(**kwargs) # noqa: E501
return data
def sms_history_get_with_http_info(self, **kwargs): # noqa: E501
"""Get all sms history # noqa: E501
Get all sms history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_history_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str q: Custom query Example: from:{number},status_code:201.
:param int date_from: Start date
:param int date_to: End date
:param int page: Page number
:param int limit: Number of records per page
:return: str
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['q', 'date_from', 'date_to', 'page', 'limit'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method sms_history_get" % key
)
params[key] = val
del params['kwargs']
if self.api_client.client_side_validation and ('page' in params and params['page'] < 1): # noqa: E501
raise ValueError("Invalid value for parameter `page` when calling `sms_history_get`, must be a value greater than or equal to `1`") # noqa: E501
if self.api_client.client_side_validation and ('limit' in params and params['limit'] < 1): # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `sms_history_get`, must be a value greater than or equal to `1`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'q' in params:
query_params.append(('q', params['q'])) # noqa: E501
if 'date_from' in params:
query_params.append(('date_from', params['date_from'])) # noqa: E501
if 'date_to' in params:
query_params.append(('date_to', params['date_to'])) # noqa: E501
if 'page' in params:
query_params.append(('page', params['page'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth'] # noqa: E501
return self.api_client.call_api(
'/sms/history', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def sms_inbound_get(self, **kwargs): # noqa: E501
"""Get all inbound sms # noqa: E501
Get all inbound sms # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_inbound_get(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str q: Your keyword or query.
:param int page: Page number
:param int limit: Number of records per page
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.sms_inbound_get_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.sms_inbound_get_with_http_info(**kwargs) # noqa: E501
return data
def sms_inbound_get_with_http_info(self, **kwargs): # noqa: E501
"""Get all inbound sms # noqa: E501
Get all inbound sms # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_inbound_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param str q: Your keyword or query.
:param int page: Page number
:param int limit: Number of records per page
:return: str
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['q', 'page', 'limit'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method sms_inbound_get" % key
)
params[key] = val
del params['kwargs']
if self.api_client.client_side_validation and ('page' in params and params['page'] < 1): # noqa: E501
raise ValueError("Invalid value for parameter `page` when calling `sms_inbound_get`, must be a value greater than or equal to `1`") # noqa: E501
if self.api_client.client_side_validation and ('limit' in params and params['limit'] < 1): # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `sms_inbound_get`, must be a value greater than or equal to `1`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'q' in params:
query_params.append(('q', params['q'])) # noqa: E501
if 'page' in params:
query_params.append(('page', params['page'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth'] # noqa: E501
return self.api_client.call_api(
'/sms/inbound', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def sms_inbound_post(self, url, **kwargs): # noqa: E501
"""Create inbound sms # noqa: E501
Create inbound sms # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_inbound_post(url, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Url url: Url model (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.sms_inbound_post_with_http_info(url, **kwargs) # noqa: E501
else:
(data) = self.sms_inbound_post_with_http_info(url, **kwargs) # noqa: E501
return data
def sms_inbound_post_with_http_info(self, url, **kwargs): # noqa: E501
"""Create inbound sms # noqa: E501
Create inbound sms # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_inbound_post_with_http_info(url, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Url url: Url model (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['url'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method sms_inbound_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'url' is set
if self.api_client.client_side_validation and ('url' not in params or
params['url'] is None): # noqa: E501
raise ValueError("Missing the required parameter `url` when calling `sms_inbound_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'url' in params:
body_params = params['url']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth'] # noqa: E501
return self.api_client.call_api(
'/sms/inbound', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def sms_inbound_read_by_message_id_put(self, message_id, **kwargs): # noqa: E501
"""Mark inbound SMS as read # noqa: E501
Mark specific inbound SMS as read # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_inbound_read_by_message_id_put(message_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str message_id: Message ID (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.sms_inbound_read_by_message_id_put_with_http_info(message_id, **kwargs) # noqa: E501
else:
(data) = self.sms_inbound_read_by_message_id_put_with_http_info(message_id, **kwargs) # noqa: E501
return data
def sms_inbound_read_by_message_id_put_with_http_info(self, message_id, **kwargs): # noqa: E501
"""Mark inbound SMS as read # noqa: E501
Mark specific inbound SMS as read # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_inbound_read_by_message_id_put_with_http_info(message_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str message_id: Message ID (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['message_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method sms_inbound_read_by_message_id_put" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'message_id' is set
if self.api_client.client_side_validation and ('message_id' not in params or
params['message_id'] is None): # noqa: E501
raise ValueError("Missing the required parameter `message_id` when calling `sms_inbound_read_by_message_id_put`") # noqa: E501
collection_formats = {}
path_params = {}
if 'message_id' in params:
path_params['message_id'] = params['message_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth'] # noqa: E501
return self.api_client.call_api(
'/sms/inbound-read/{message_id}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def sms_inbound_read_put(self, **kwargs): # noqa: E501
"""Mark inbound SMS as read # noqa: E501
Mark all inbound SMS as read optionally before a certain date # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_inbound_read_put(async_req=True)
>>> result = thread.get()
:param async_req bool
:param DateBefore date_before: DateBefore model
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.sms_inbound_read_put_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.sms_inbound_read_put_with_http_info(**kwargs) # noqa: E501
return data
def sms_inbound_read_put_with_http_info(self, **kwargs): # noqa: E501
"""Mark inbound SMS as read # noqa: E501
Mark all inbound SMS as read optionally before a certain date # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_inbound_read_put_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param DateBefore date_before: DateBefore model
:return: str
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['date_before'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method sms_inbound_read_put" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'date_before' in params:
body_params = params['date_before']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth'] # noqa: E501
return self.api_client.call_api(
'/sms/inbound-read', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def sms_price_post(self, sms_messages, **kwargs): # noqa: E501
"""Calculate sms price # noqa: E501
Calculate sms price # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_price_post(sms_messages, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SmsMessageCollection sms_messages: SmsMessageCollection model (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.sms_price_post_with_http_info(sms_messages, **kwargs) # noqa: E501
else:
(data) = self.sms_price_post_with_http_info(sms_messages, **kwargs) # noqa: E501
return data
def sms_price_post_with_http_info(self, sms_messages, **kwargs): # noqa: E501
"""Calculate sms price # noqa: E501
Calculate sms price # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_price_post_with_http_info(sms_messages, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SmsMessageCollection sms_messages: SmsMessageCollection model (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['sms_messages'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method sms_price_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'sms_messages' is set
if self.api_client.client_side_validation and ('sms_messages' not in params or
params['sms_messages'] is None): # noqa: E501
raise ValueError("Missing the required parameter `sms_messages` when calling `sms_price_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'sms_messages' in params:
body_params = params['sms_messages']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth'] # noqa: E501
return self.api_client.call_api(
'/sms/price', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def sms_receipts_by_message_id_get(self, message_id, **kwargs): # noqa: E501
"""Get a Specific Delivery Receipt # noqa: E501
Get a Specific Delivery Receipt # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_receipts_by_message_id_get(message_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str message_id: Message ID (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.sms_receipts_by_message_id_get_with_http_info(message_id, **kwargs) # noqa: E501
else:
(data) = self.sms_receipts_by_message_id_get_with_http_info(message_id, **kwargs) # noqa: E501
return data
def sms_receipts_by_message_id_get_with_http_info(self, message_id, **kwargs): # noqa: E501
"""Get a Specific Delivery Receipt # noqa: E501
Get a Specific Delivery Receipt # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_receipts_by_message_id_get_with_http_info(message_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str message_id: Message ID (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['message_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method sms_receipts_by_message_id_get" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'message_id' is set
if self.api_client.client_side_validation and ('message_id' not in params or
params['message_id'] is None): # noqa: E501
raise ValueError("Missing the required parameter `message_id` when calling `sms_receipts_by_message_id_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'message_id' in params:
path_params['message_id'] = params['message_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth'] # noqa: E501
return self.api_client.call_api(
'/sms/receipts/{message_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def sms_receipts_get(self, **kwargs): # noqa: E501
"""Get all delivery receipts # noqa: E501
Get all delivery receipts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_receipts_get(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int page: Page number
:param int limit: Number of records per page
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.sms_receipts_get_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.sms_receipts_get_with_http_info(**kwargs) # noqa: E501
return data
def sms_receipts_get_with_http_info(self, **kwargs): # noqa: E501
"""Get all delivery receipts # noqa: E501
Get all delivery receipts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_receipts_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int page: Page number
:param int limit: Number of records per page
:return: str
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['page', 'limit'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method sms_receipts_get" % key
)
params[key] = val
del params['kwargs']
if self.api_client.client_side_validation and ('page' in params and params['page'] < 1): # noqa: E501
raise ValueError("Invalid value for parameter `page` when calling `sms_receipts_get`, must be a value greater than or equal to `1`") # noqa: E501
if self.api_client.client_side_validation and ('limit' in params and params['limit'] < 1): # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `sms_receipts_get`, must be a value greater than or equal to `1`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'page' in params:
query_params.append(('page', params['page'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth'] # noqa: E501
return self.api_client.call_api(
'/sms/receipts', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def sms_receipts_post(self, url, **kwargs): # noqa: E501
"""Add a delivery receipt # noqa: E501
Add a delivery receipt # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_receipts_post(url, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Url url: Url model (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.sms_receipts_post_with_http_info(url, **kwargs) # noqa: E501
else:
(data) = self.sms_receipts_post_with_http_info(url, **kwargs) # noqa: E501
return data
def sms_receipts_post_with_http_info(self, url, **kwargs): # noqa: E501
"""Add a delivery receipt # noqa: E501
Add a delivery receipt # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_receipts_post_with_http_info(url, async_req=True)
>>> result = thread.get()
:param async_req bool
:param Url url: Url model (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['url'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method sms_receipts_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'url' is set
if self.api_client.client_side_validation and ('url' not in params or
params['url'] is None): # noqa: E501
raise ValueError("Missing the required parameter `url` when calling `sms_receipts_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'url' in params:
body_params = params['url']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth'] # noqa: E501
return self.api_client.call_api(
'/sms/receipts', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def sms_receipts_read_put(self, **kwargs): # noqa: E501
"""Mark delivery receipts as read # noqa: E501
Mark delivery receipts as read # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_receipts_read_put(async_req=True)
>>> result = thread.get()
:param async_req bool
:param DateBefore date_before: DateBefore model
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.sms_receipts_read_put_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.sms_receipts_read_put_with_http_info(**kwargs) # noqa: E501
return data
def sms_receipts_read_put_with_http_info(self, **kwargs): # noqa: E501
"""Mark delivery receipts as read # noqa: E501
Mark delivery receipts as read # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_receipts_read_put_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param DateBefore date_before: DateBefore model
:return: str
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['date_before'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method sms_receipts_read_put" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'date_before' in params:
body_params = params['date_before']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth'] # noqa: E501
return self.api_client.call_api(
'/sms/receipts-read', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def sms_send_post(self, sms_messages, **kwargs): # noqa: E501
"""Send sms message(s) # noqa: E501
# Send one or more SMS messages You can post up to 1000 messages with each API call. You can send to a mix of contacts and contact lists, as long as the total number of recipients is up to 1000. The response contains status and details for each recipient. *Refer to [Application Status Codes](https://dashboard.clicksend.com/#/signup/step1/) for the possible response message status strings.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_send_post(sms_messages, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SmsMessageCollection sms_messages: SmsMessageCollection model (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.sms_send_post_with_http_info(sms_messages, **kwargs) # noqa: E501
else:
(data) = self.sms_send_post_with_http_info(sms_messages, **kwargs) # noqa: E501
return data
def sms_send_post_with_http_info(self, sms_messages, **kwargs): # noqa: E501
"""Send sms message(s) # noqa: E501
# Send one or more SMS messages You can post up to 1000 messages with each API call. You can send to a mix of contacts and contact lists, as long as the total number of recipients is up to 1000. The response contains status and details for each recipient. *Refer to [Application Status Codes](https://dashboard.clicksend.com/#/signup/step1/) for the possible response message status strings.* # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_send_post_with_http_info(sms_messages, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SmsMessageCollection sms_messages: SmsMessageCollection model (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['sms_messages'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method sms_send_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'sms_messages' is set
if self.api_client.client_side_validation and ('sms_messages' not in params or
params['sms_messages'] is None): # noqa: E501
raise ValueError("Missing the required parameter `sms_messages` when calling `sms_send_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'sms_messages' in params:
body_params = params['sms_messages']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth'] # noqa: E501
return self.api_client.call_api(
'/sms/send', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def sms_templates_by_template_id_delete(self, template_id, **kwargs): # noqa: E501
"""Delete sms template # noqa: E501
Delete sms template # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_templates_by_template_id_delete(template_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: Template id (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.sms_templates_by_template_id_delete_with_http_info(template_id, **kwargs) # noqa: E501
else:
(data) = self.sms_templates_by_template_id_delete_with_http_info(template_id, **kwargs) # noqa: E501
return data
def sms_templates_by_template_id_delete_with_http_info(self, template_id, **kwargs): # noqa: E501
"""Delete sms template # noqa: E501
Delete sms template # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_templates_by_template_id_delete_with_http_info(template_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: Template id (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['template_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method sms_templates_by_template_id_delete" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'template_id' is set
if self.api_client.client_side_validation and ('template_id' not in params or
params['template_id'] is None): # noqa: E501
raise ValueError("Missing the required parameter `template_id` when calling `sms_templates_by_template_id_delete`") # noqa: E501
collection_formats = {}
path_params = {}
if 'template_id' in params:
path_params['template_id'] = params['template_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth'] # noqa: E501
return self.api_client.call_api(
'/sms/templates/{template_id}', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def sms_templates_by_template_id_put(self, template_id, sms_template, **kwargs): # noqa: E501
"""Update sms template # noqa: E501
Update sms template # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_templates_by_template_id_put(template_id, sms_template, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: Template id (required)
:param SmsTemplate sms_template: Template item (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.sms_templates_by_template_id_put_with_http_info(template_id, sms_template, **kwargs) # noqa: E501
else:
(data) = self.sms_templates_by_template_id_put_with_http_info(template_id, sms_template, **kwargs) # noqa: E501
return data
def sms_templates_by_template_id_put_with_http_info(self, template_id, sms_template, **kwargs): # noqa: E501
"""Update sms template # noqa: E501
Update sms template # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_templates_by_template_id_put_with_http_info(template_id, sms_template, async_req=True)
>>> result = thread.get()
:param async_req bool
:param int template_id: Template id (required)
:param SmsTemplate sms_template: Template item (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['template_id', 'sms_template'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method sms_templates_by_template_id_put" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'template_id' is set
if self.api_client.client_side_validation and ('template_id' not in params or
params['template_id'] is None): # noqa: E501
raise ValueError("Missing the required parameter `template_id` when calling `sms_templates_by_template_id_put`") # noqa: E501
# verify the required parameter 'sms_template' is set
if self.api_client.client_side_validation and ('sms_template' not in params or
params['sms_template'] is None): # noqa: E501
raise ValueError("Missing the required parameter `sms_template` when calling `sms_templates_by_template_id_put`") # noqa: E501
collection_formats = {}
path_params = {}
if 'template_id' in params:
path_params['template_id'] = params['template_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'sms_template' in params:
body_params = params['sms_template']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth'] # noqa: E501
return self.api_client.call_api(
'/sms/templates/{template_id}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def sms_templates_get(self, **kwargs): # noqa: E501
"""Get lists of all sms templates # noqa: E501
Get lists of all sms templates # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_templates_get(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int page: Page number
:param int limit: Number of records per page
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.sms_templates_get_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.sms_templates_get_with_http_info(**kwargs) # noqa: E501
return data
def sms_templates_get_with_http_info(self, **kwargs): # noqa: E501
"""Get lists of all sms templates # noqa: E501
Get lists of all sms templates # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_templates_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param int page: Page number
:param int limit: Number of records per page
:return: str
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['page', 'limit'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method sms_templates_get" % key
)
params[key] = val
del params['kwargs']
if self.api_client.client_side_validation and ('page' in params and params['page'] < 1): # noqa: E501
raise ValueError("Invalid value for parameter `page` when calling `sms_templates_get`, must be a value greater than or equal to `1`") # noqa: E501
if self.api_client.client_side_validation and ('limit' in params and params['limit'] < 1): # noqa: E501
raise ValueError("Invalid value for parameter `limit` when calling `sms_templates_get`, must be a value greater than or equal to `1`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'page' in params:
query_params.append(('page', params['page'])) # noqa: E501
if 'limit' in params:
query_params.append(('limit', params['limit'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth'] # noqa: E501
return self.api_client.call_api(
'/sms/templates', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def sms_templates_post(self, sms_template, **kwargs): # noqa: E501
"""Create sms template # noqa: E501
Create sms template # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_templates_post(sms_template, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SmsTemplate sms_template: SmsTemplate model (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.sms_templates_post_with_http_info(sms_template, **kwargs) # noqa: E501
else:
(data) = self.sms_templates_post_with_http_info(sms_template, **kwargs) # noqa: E501
return data
def sms_templates_post_with_http_info(self, sms_template, **kwargs): # noqa: E501
"""Create sms template # noqa: E501
Create sms template # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sms_templates_post_with_http_info(sms_template, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SmsTemplate sms_template: SmsTemplate model (required)
:return: str
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['sms_template'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method sms_templates_post" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'sms_template' is set
if self.api_client.client_side_validation and ('sms_template' not in params or
params['sms_template'] is None): # noqa: E501
raise ValueError("Missing the required parameter `sms_template` when calling `sms_templates_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'sms_template' in params:
body_params = params['sms_template']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['BasicAuth'] # noqa: E501
return self.api_client.call_api(
'/sms/templates', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)