index
int64 0
731k
| package
stringlengths 2
98
⌀ | name
stringlengths 1
76
| docstring
stringlengths 0
281k
⌀ | code
stringlengths 4
1.07M
⌀ | signature
stringlengths 2
42.8k
⌀ |
|---|---|---|---|---|---|
62,693 |
mailchimp_transactional.api.senders_api
|
info_with_http_info
|
Get sender info # noqa: E501
Return more detailed information about a single sender, including aggregates of recent stats. # noqa: E501
|
def info_with_http_info(self, body, **kwargs): # noqa: E501
"""Get sender info # noqa: E501
Return more detailed information about a single sender, including aggregates of recent stats. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 info" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/senders/info', 'POST',
body=body_params,
response_type='InlineResponse20048') # noqa: E501
|
(self, body, **kwargs)
|
62,694 |
mailchimp_transactional.api.senders_api
|
list
|
List account senders # noqa: E501
Return the senders that have tried to use this account. # noqa: E501
|
def list(self, body = {}, **kwargs): # noqa: E501
"""List account senders # noqa: E501
Return the senders that have tried to use this account. # noqa: E501
"""
(data) = self.list_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,695 |
mailchimp_transactional.api.senders_api
|
list_with_http_info
|
List account senders # noqa: E501
Return the senders that have tried to use this account. # noqa: E501
|
def list_with_http_info(self, body, **kwargs): # noqa: E501
"""List account senders # noqa: E501
Return the senders that have tried to use this account. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 list" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/senders/list', 'POST',
body=body_params,
response_type='list[InlineResponse20043]') # noqa: E501
|
(self, body, **kwargs)
|
62,696 |
mailchimp_transactional.api.senders_api
|
time_series
|
View sender history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a sender. # noqa: E501
|
def time_series(self, body = {}, **kwargs): # noqa: E501
"""View sender history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a sender. # noqa: E501
"""
(data) = self.time_series_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,697 |
mailchimp_transactional.api.senders_api
|
time_series_with_http_info
|
View sender history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a sender. # noqa: E501
|
def time_series_with_http_info(self, body, **kwargs): # noqa: E501
"""View sender history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a sender. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 time_series" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/senders/time-series', 'POST',
body=body_params,
response_type='list[InlineResponse20049]') # noqa: E501
|
(self, body, **kwargs)
|
62,698 |
mailchimp_transactional.api.senders_api
|
verify_domain
|
Verify domain # noqa: E501
Sends a verification email in order to verify ownership of a domain. Domain verification is a required step to confirm ownership of a domain. Once a domain has been verified in a Transactional API account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Transactional API accounts from sending mail signed by your domain. # noqa: E501
|
def verify_domain(self, body = {}, **kwargs): # noqa: E501
"""Verify domain # noqa: E501
Sends a verification email in order to verify ownership of a domain. Domain verification is a required step to confirm ownership of a domain. Once a domain has been verified in a Transactional API account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Transactional API accounts from sending mail signed by your domain. # noqa: E501
"""
(data) = self.verify_domain_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,699 |
mailchimp_transactional.api.senders_api
|
verify_domain_with_http_info
|
Verify domain # noqa: E501
Sends a verification email in order to verify ownership of a domain. Domain verification is a required step to confirm ownership of a domain. Once a domain has been verified in a Transactional API account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Transactional API accounts from sending mail signed by your domain. # noqa: E501
|
def verify_domain_with_http_info(self, body, **kwargs): # noqa: E501
"""Verify domain # noqa: E501
Sends a verification email in order to verify ownership of a domain. Domain verification is a required step to confirm ownership of a domain. Once a domain has been verified in a Transactional API account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Transactional API accounts from sending mail signed by your domain. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 verify_domain" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/senders/verify-domain', 'POST',
body=body_params,
response_type='InlineResponse20047') # noqa: E501
|
(self, body, **kwargs)
|
62,700 |
mailchimp_transactional.api.subaccounts_api
|
SubaccountsApi
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
|
class SubaccountsApi(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""
def __init__(self, api_key='', api_client = None):
self.api_key = api_key
if api_client:
self.api_client = api_client
else:
self.api_client = ApiClient()
def add(self, body = {}, **kwargs): # noqa: E501
"""Add subaccount # noqa: E501
Add a new subaccount. # noqa: E501
"""
(data) = self.add_with_http_info(body, **kwargs) # noqa: E501
return data
def add_with_http_info(self, body, **kwargs): # noqa: E501
"""Add subaccount # noqa: E501
Add a new subaccount. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 add" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/subaccounts/add', 'POST',
body=body_params,
response_type='InlineResponse20051') # noqa: E501
def delete(self, body = {}, **kwargs): # noqa: E501
"""Delete subaccount # noqa: E501
Delete an existing subaccount. Any email related to the subaccount will be saved, but stats will be removed and any future sending calls to this subaccount will fail. # noqa: E501
"""
(data) = self.delete_with_http_info(body, **kwargs) # noqa: E501
return data
def delete_with_http_info(self, body, **kwargs): # noqa: E501
"""Delete subaccount # noqa: E501
Delete an existing subaccount. Any email related to the subaccount will be saved, but stats will be removed and any future sending calls to this subaccount will fail. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 delete" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/subaccounts/delete', 'POST',
body=body_params,
response_type='InlineResponse20054') # noqa: E501
def info(self, body = {}, **kwargs): # noqa: E501
"""Get subaccount info # noqa: E501
Given the ID of an existing subaccount, return the data about it. # noqa: E501
"""
(data) = self.info_with_http_info(body, **kwargs) # noqa: E501
return data
def info_with_http_info(self, body, **kwargs): # noqa: E501
"""Get subaccount info # noqa: E501
Given the ID of an existing subaccount, return the data about it. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 info" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/subaccounts/info', 'POST',
body=body_params,
response_type='InlineResponse20052') # noqa: E501
def list(self, body = {}, **kwargs): # noqa: E501
"""List subaccounts # noqa: E501
Get the list of subaccounts defined for the account, optionally filtered by a prefix. # noqa: E501
"""
(data) = self.list_with_http_info(body, **kwargs) # noqa: E501
return data
def list_with_http_info(self, body, **kwargs): # noqa: E501
"""List subaccounts # noqa: E501
Get the list of subaccounts defined for the account, optionally filtered by a prefix. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 list" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/subaccounts/list', 'POST',
body=body_params,
response_type='list[InlineResponse20050]') # noqa: E501
def pause(self, body = {}, **kwargs): # noqa: E501
"""Pause subaccount # noqa: E501
Pause a subaccount's sending. Any future emails delivered to this subaccount will be queued for a maximum of 3 days until the subaccount is resumed. # noqa: E501
"""
(data) = self.pause_with_http_info(body, **kwargs) # noqa: E501
return data
def pause_with_http_info(self, body, **kwargs): # noqa: E501
"""Pause subaccount # noqa: E501
Pause a subaccount's sending. Any future emails delivered to this subaccount will be queued for a maximum of 3 days until the subaccount is resumed. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 pause" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/subaccounts/pause', 'POST',
body=body_params,
response_type='InlineResponse20055') # noqa: E501
def resume(self, body = {}, **kwargs): # noqa: E501
"""Resume subaccount # noqa: E501
Resume a paused subaccount's sending. # noqa: E501
"""
(data) = self.resume_with_http_info(body, **kwargs) # noqa: E501
return data
def resume_with_http_info(self, body, **kwargs): # noqa: E501
"""Resume subaccount # noqa: E501
Resume a paused subaccount's sending. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 resume" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/subaccounts/resume', 'POST',
body=body_params,
response_type='InlineResponse20056') # noqa: E501
def update(self, body = {}, **kwargs): # noqa: E501
"""Update subaccount # noqa: E501
Update an existing subaccount. # noqa: E501
"""
(data) = self.update_with_http_info(body, **kwargs) # noqa: E501
return data
def update_with_http_info(self, body, **kwargs): # noqa: E501
"""Update subaccount # noqa: E501
Update an existing subaccount. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 update" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/subaccounts/update', 'POST',
body=body_params,
response_type='InlineResponse20053') # noqa: E501
|
(api_key='', api_client=None)
|
62,702 |
mailchimp_transactional.api.subaccounts_api
|
add
|
Add subaccount # noqa: E501
Add a new subaccount. # noqa: E501
|
def add(self, body = {}, **kwargs): # noqa: E501
"""Add subaccount # noqa: E501
Add a new subaccount. # noqa: E501
"""
(data) = self.add_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,703 |
mailchimp_transactional.api.subaccounts_api
|
add_with_http_info
|
Add subaccount # noqa: E501
Add a new subaccount. # noqa: E501
|
def add_with_http_info(self, body, **kwargs): # noqa: E501
"""Add subaccount # noqa: E501
Add a new subaccount. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 add" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/subaccounts/add', 'POST',
body=body_params,
response_type='InlineResponse20051') # noqa: E501
|
(self, body, **kwargs)
|
62,704 |
mailchimp_transactional.api.subaccounts_api
|
delete
|
Delete subaccount # noqa: E501
Delete an existing subaccount. Any email related to the subaccount will be saved, but stats will be removed and any future sending calls to this subaccount will fail. # noqa: E501
|
def delete(self, body = {}, **kwargs): # noqa: E501
"""Delete subaccount # noqa: E501
Delete an existing subaccount. Any email related to the subaccount will be saved, but stats will be removed and any future sending calls to this subaccount will fail. # noqa: E501
"""
(data) = self.delete_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,705 |
mailchimp_transactional.api.subaccounts_api
|
delete_with_http_info
|
Delete subaccount # noqa: E501
Delete an existing subaccount. Any email related to the subaccount will be saved, but stats will be removed and any future sending calls to this subaccount will fail. # noqa: E501
|
def delete_with_http_info(self, body, **kwargs): # noqa: E501
"""Delete subaccount # noqa: E501
Delete an existing subaccount. Any email related to the subaccount will be saved, but stats will be removed and any future sending calls to this subaccount will fail. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 delete" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/subaccounts/delete', 'POST',
body=body_params,
response_type='InlineResponse20054') # noqa: E501
|
(self, body, **kwargs)
|
62,706 |
mailchimp_transactional.api.subaccounts_api
|
info
|
Get subaccount info # noqa: E501
Given the ID of an existing subaccount, return the data about it. # noqa: E501
|
def info(self, body = {}, **kwargs): # noqa: E501
"""Get subaccount info # noqa: E501
Given the ID of an existing subaccount, return the data about it. # noqa: E501
"""
(data) = self.info_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,707 |
mailchimp_transactional.api.subaccounts_api
|
info_with_http_info
|
Get subaccount info # noqa: E501
Given the ID of an existing subaccount, return the data about it. # noqa: E501
|
def info_with_http_info(self, body, **kwargs): # noqa: E501
"""Get subaccount info # noqa: E501
Given the ID of an existing subaccount, return the data about it. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 info" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/subaccounts/info', 'POST',
body=body_params,
response_type='InlineResponse20052') # noqa: E501
|
(self, body, **kwargs)
|
62,708 |
mailchimp_transactional.api.subaccounts_api
|
list
|
List subaccounts # noqa: E501
Get the list of subaccounts defined for the account, optionally filtered by a prefix. # noqa: E501
|
def list(self, body = {}, **kwargs): # noqa: E501
"""List subaccounts # noqa: E501
Get the list of subaccounts defined for the account, optionally filtered by a prefix. # noqa: E501
"""
(data) = self.list_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,709 |
mailchimp_transactional.api.subaccounts_api
|
list_with_http_info
|
List subaccounts # noqa: E501
Get the list of subaccounts defined for the account, optionally filtered by a prefix. # noqa: E501
|
def list_with_http_info(self, body, **kwargs): # noqa: E501
"""List subaccounts # noqa: E501
Get the list of subaccounts defined for the account, optionally filtered by a prefix. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 list" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/subaccounts/list', 'POST',
body=body_params,
response_type='list[InlineResponse20050]') # noqa: E501
|
(self, body, **kwargs)
|
62,710 |
mailchimp_transactional.api.subaccounts_api
|
pause
|
Pause subaccount # noqa: E501
Pause a subaccount's sending. Any future emails delivered to this subaccount will be queued for a maximum of 3 days until the subaccount is resumed. # noqa: E501
|
def pause(self, body = {}, **kwargs): # noqa: E501
"""Pause subaccount # noqa: E501
Pause a subaccount's sending. Any future emails delivered to this subaccount will be queued for a maximum of 3 days until the subaccount is resumed. # noqa: E501
"""
(data) = self.pause_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,711 |
mailchimp_transactional.api.subaccounts_api
|
pause_with_http_info
|
Pause subaccount # noqa: E501
Pause a subaccount's sending. Any future emails delivered to this subaccount will be queued for a maximum of 3 days until the subaccount is resumed. # noqa: E501
|
def pause_with_http_info(self, body, **kwargs): # noqa: E501
"""Pause subaccount # noqa: E501
Pause a subaccount's sending. Any future emails delivered to this subaccount will be queued for a maximum of 3 days until the subaccount is resumed. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 pause" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/subaccounts/pause', 'POST',
body=body_params,
response_type='InlineResponse20055') # noqa: E501
|
(self, body, **kwargs)
|
62,712 |
mailchimp_transactional.api.subaccounts_api
|
resume
|
Resume subaccount # noqa: E501
Resume a paused subaccount's sending. # noqa: E501
|
def resume(self, body = {}, **kwargs): # noqa: E501
"""Resume subaccount # noqa: E501
Resume a paused subaccount's sending. # noqa: E501
"""
(data) = self.resume_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,713 |
mailchimp_transactional.api.subaccounts_api
|
resume_with_http_info
|
Resume subaccount # noqa: E501
Resume a paused subaccount's sending. # noqa: E501
|
def resume_with_http_info(self, body, **kwargs): # noqa: E501
"""Resume subaccount # noqa: E501
Resume a paused subaccount's sending. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 resume" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/subaccounts/resume', 'POST',
body=body_params,
response_type='InlineResponse20056') # noqa: E501
|
(self, body, **kwargs)
|
62,714 |
mailchimp_transactional.api.subaccounts_api
|
update
|
Update subaccount # noqa: E501
Update an existing subaccount. # noqa: E501
|
def update(self, body = {}, **kwargs): # noqa: E501
"""Update subaccount # noqa: E501
Update an existing subaccount. # noqa: E501
"""
(data) = self.update_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,715 |
mailchimp_transactional.api.subaccounts_api
|
update_with_http_info
|
Update subaccount # noqa: E501
Update an existing subaccount. # noqa: E501
|
def update_with_http_info(self, body, **kwargs): # noqa: E501
"""Update subaccount # noqa: E501
Update an existing subaccount. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 update" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/subaccounts/update', 'POST',
body=body_params,
response_type='InlineResponse20053') # noqa: E501
|
(self, body, **kwargs)
|
62,716 |
mailchimp_transactional.api.tags_api
|
TagsApi
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
|
class TagsApi(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""
def __init__(self, api_key='', api_client = None):
self.api_key = api_key
if api_client:
self.api_client = api_client
else:
self.api_client = ApiClient()
def all_time_series(self, body = {}, **kwargs): # noqa: E501
"""View all tags history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for all tags. # noqa: E501
"""
(data) = self.all_time_series_with_http_info(body, **kwargs) # noqa: E501
return data
def all_time_series_with_http_info(self, body, **kwargs): # noqa: E501
"""View all tags history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for all tags. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 all_time_series" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/tags/all-time-series', 'POST',
body=body_params,
response_type='list[InlineResponse20031]') # noqa: E501
def delete(self, body = {}, **kwargs): # noqa: E501
"""Delete tag # noqa: E501
Deletes a tag permanently. Deleting a tag removes the tag from any messages that have been sent, and also deletes the tag's stats. There is no way to undo this operation, so use it carefully. # noqa: E501
"""
(data) = self.delete_with_http_info(body, **kwargs) # noqa: E501
return data
def delete_with_http_info(self, body, **kwargs): # noqa: E501
"""Delete tag # noqa: E501
Deletes a tag permanently. Deleting a tag removes the tag from any messages that have been sent, and also deletes the tag's stats. There is no way to undo this operation, so use it carefully. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 delete" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/tags/delete', 'POST',
body=body_params,
response_type='InlineResponse20058') # noqa: E501
def info(self, body = {}, **kwargs): # noqa: E501
"""Get tag info # noqa: E501
Return more detailed information about a single tag, including aggregates of recent stats. # noqa: E501
"""
(data) = self.info_with_http_info(body, **kwargs) # noqa: E501
return data
def info_with_http_info(self, body, **kwargs): # noqa: E501
"""Get tag info # noqa: E501
Return more detailed information about a single tag, including aggregates of recent stats. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 info" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/tags/info', 'POST',
body=body_params,
response_type='InlineResponse20059') # noqa: E501
def list(self, body = {}, **kwargs): # noqa: E501
"""List tags # noqa: E501
Return all of the user-defined tag information. # noqa: E501
"""
(data) = self.list_with_http_info(body, **kwargs) # noqa: E501
return data
def list_with_http_info(self, body, **kwargs): # noqa: E501
"""List tags # noqa: E501
Return all of the user-defined tag information. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 list" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/tags/list', 'POST',
body=body_params,
response_type='list[InlineResponse20057]') # noqa: E501
def time_series(self, body = {}, **kwargs): # noqa: E501
"""View tag history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a tag. # noqa: E501
"""
(data) = self.time_series_with_http_info(body, **kwargs) # noqa: E501
return data
def time_series_with_http_info(self, body, **kwargs): # noqa: E501
"""View tag history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a tag. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 time_series" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/tags/time-series', 'POST',
body=body_params,
response_type='list[InlineResponse20031]') # noqa: E501
|
(api_key='', api_client=None)
|
62,718 |
mailchimp_transactional.api.tags_api
|
all_time_series
|
View all tags history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for all tags. # noqa: E501
|
def all_time_series(self, body = {}, **kwargs): # noqa: E501
"""View all tags history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for all tags. # noqa: E501
"""
(data) = self.all_time_series_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,719 |
mailchimp_transactional.api.tags_api
|
all_time_series_with_http_info
|
View all tags history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for all tags. # noqa: E501
|
def all_time_series_with_http_info(self, body, **kwargs): # noqa: E501
"""View all tags history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for all tags. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 all_time_series" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/tags/all-time-series', 'POST',
body=body_params,
response_type='list[InlineResponse20031]') # noqa: E501
|
(self, body, **kwargs)
|
62,720 |
mailchimp_transactional.api.tags_api
|
delete
|
Delete tag # noqa: E501
Deletes a tag permanently. Deleting a tag removes the tag from any messages that have been sent, and also deletes the tag's stats. There is no way to undo this operation, so use it carefully. # noqa: E501
|
def delete(self, body = {}, **kwargs): # noqa: E501
"""Delete tag # noqa: E501
Deletes a tag permanently. Deleting a tag removes the tag from any messages that have been sent, and also deletes the tag's stats. There is no way to undo this operation, so use it carefully. # noqa: E501
"""
(data) = self.delete_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,721 |
mailchimp_transactional.api.tags_api
|
delete_with_http_info
|
Delete tag # noqa: E501
Deletes a tag permanently. Deleting a tag removes the tag from any messages that have been sent, and also deletes the tag's stats. There is no way to undo this operation, so use it carefully. # noqa: E501
|
def delete_with_http_info(self, body, **kwargs): # noqa: E501
"""Delete tag # noqa: E501
Deletes a tag permanently. Deleting a tag removes the tag from any messages that have been sent, and also deletes the tag's stats. There is no way to undo this operation, so use it carefully. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 delete" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/tags/delete', 'POST',
body=body_params,
response_type='InlineResponse20058') # noqa: E501
|
(self, body, **kwargs)
|
62,722 |
mailchimp_transactional.api.tags_api
|
info
|
Get tag info # noqa: E501
Return more detailed information about a single tag, including aggregates of recent stats. # noqa: E501
|
def info(self, body = {}, **kwargs): # noqa: E501
"""Get tag info # noqa: E501
Return more detailed information about a single tag, including aggregates of recent stats. # noqa: E501
"""
(data) = self.info_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,723 |
mailchimp_transactional.api.tags_api
|
info_with_http_info
|
Get tag info # noqa: E501
Return more detailed information about a single tag, including aggregates of recent stats. # noqa: E501
|
def info_with_http_info(self, body, **kwargs): # noqa: E501
"""Get tag info # noqa: E501
Return more detailed information about a single tag, including aggregates of recent stats. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 info" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/tags/info', 'POST',
body=body_params,
response_type='InlineResponse20059') # noqa: E501
|
(self, body, **kwargs)
|
62,724 |
mailchimp_transactional.api.tags_api
|
list
|
List tags # noqa: E501
Return all of the user-defined tag information. # noqa: E501
|
def list(self, body = {}, **kwargs): # noqa: E501
"""List tags # noqa: E501
Return all of the user-defined tag information. # noqa: E501
"""
(data) = self.list_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,725 |
mailchimp_transactional.api.tags_api
|
list_with_http_info
|
List tags # noqa: E501
Return all of the user-defined tag information. # noqa: E501
|
def list_with_http_info(self, body, **kwargs): # noqa: E501
"""List tags # noqa: E501
Return all of the user-defined tag information. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 list" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/tags/list', 'POST',
body=body_params,
response_type='list[InlineResponse20057]') # noqa: E501
|
(self, body, **kwargs)
|
62,726 |
mailchimp_transactional.api.tags_api
|
time_series
|
View tag history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a tag. # noqa: E501
|
def time_series(self, body = {}, **kwargs): # noqa: E501
"""View tag history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a tag. # noqa: E501
"""
(data) = self.time_series_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,727 |
mailchimp_transactional.api.tags_api
|
time_series_with_http_info
|
View tag history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a tag. # noqa: E501
|
def time_series_with_http_info(self, body, **kwargs): # noqa: E501
"""View tag history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a tag. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 time_series" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/tags/time-series', 'POST',
body=body_params,
response_type='list[InlineResponse20031]') # noqa: E501
|
(self, body, **kwargs)
|
62,728 |
mailchimp_transactional.api.templates_api
|
TemplatesApi
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
|
class TemplatesApi(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""
def __init__(self, api_key='', api_client = None):
self.api_key = api_key
if api_client:
self.api_client = api_client
else:
self.api_client = ApiClient()
def add(self, body = {}, **kwargs): # noqa: E501
"""Add template # noqa: E501
Add a new template. # noqa: E501
"""
(data) = self.add_with_http_info(body, **kwargs) # noqa: E501
return data
def add_with_http_info(self, body, **kwargs): # noqa: E501
"""Add template # noqa: E501
Add a new template. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 add" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/templates/add', 'POST',
body=body_params,
response_type='InlineResponse20060') # noqa: E501
def delete(self, body = {}, **kwargs): # noqa: E501
"""Delete template # noqa: E501
Delete a template. # noqa: E501
"""
(data) = self.delete_with_http_info(body, **kwargs) # noqa: E501
return data
def delete_with_http_info(self, body, **kwargs): # noqa: E501
"""Delete template # noqa: E501
Delete a template. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 delete" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/templates/delete', 'POST',
body=body_params,
response_type='InlineResponse20064') # noqa: E501
def info(self, body = {}, **kwargs): # noqa: E501
"""Get template info # noqa: E501
Get the information for an existing template. # noqa: E501
"""
(data) = self.info_with_http_info(body, **kwargs) # noqa: E501
return data
def info_with_http_info(self, body, **kwargs): # noqa: E501
"""Get template info # noqa: E501
Get the information for an existing template. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 info" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/templates/info', 'POST',
body=body_params,
response_type='InlineResponse20061') # noqa: E501
def list(self, body = {}, **kwargs): # noqa: E501
"""List templates # noqa: E501
Return a list of all the templates available to this user. # noqa: E501
"""
(data) = self.list_with_http_info(body, **kwargs) # noqa: E501
return data
def list_with_http_info(self, body, **kwargs): # noqa: E501
"""List templates # noqa: E501
Return a list of all the templates available to this user. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 list" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/templates/list', 'POST',
body=body_params,
response_type='list[InlineResponse20065]') # noqa: E501
def publish(self, body = {}, **kwargs): # noqa: E501
"""Publish template content # noqa: E501
Publish the content for the template. Any new messages sent using this template will start using the content that was previously in draft. # noqa: E501
"""
(data) = self.publish_with_http_info(body, **kwargs) # noqa: E501
return data
def publish_with_http_info(self, body, **kwargs): # noqa: E501
"""Publish template content # noqa: E501
Publish the content for the template. Any new messages sent using this template will start using the content that was previously in draft. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 publish" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/templates/publish', 'POST',
body=body_params,
response_type='InlineResponse20063') # noqa: E501
def render(self, body = {}, **kwargs): # noqa: E501
"""Render html template # noqa: E501
Inject content and optionally merge fields into a template, returning the HTML that results. # noqa: E501
"""
(data) = self.render_with_http_info(body, **kwargs) # noqa: E501
return data
def render_with_http_info(self, body, **kwargs): # noqa: E501
"""Render html template # noqa: E501
Inject content and optionally merge fields into a template, returning the HTML that results. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 render" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/templates/render', 'POST',
body=body_params,
response_type='InlineResponse20066') # noqa: E501
def time_series(self, body = {}, **kwargs): # noqa: E501
"""Get template history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a template. # noqa: E501
"""
(data) = self.time_series_with_http_info(body, **kwargs) # noqa: E501
return data
def time_series_with_http_info(self, body, **kwargs): # noqa: E501
"""Get template history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a template. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 time_series" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/templates/time-series', 'POST',
body=body_params,
response_type='list[InlineResponse20049]') # noqa: E501
def update(self, body = {}, **kwargs): # noqa: E501
"""Update template # noqa: E501
Update the code for an existing template. If null is provided for any fields, the values will remain unchanged. # noqa: E501
"""
(data) = self.update_with_http_info(body, **kwargs) # noqa: E501
return data
def update_with_http_info(self, body, **kwargs): # noqa: E501
"""Update template # noqa: E501
Update the code for an existing template. If null is provided for any fields, the values will remain unchanged. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 update" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/templates/update', 'POST',
body=body_params,
response_type='InlineResponse20062') # noqa: E501
|
(api_key='', api_client=None)
|
62,730 |
mailchimp_transactional.api.templates_api
|
add
|
Add template # noqa: E501
Add a new template. # noqa: E501
|
def add(self, body = {}, **kwargs): # noqa: E501
"""Add template # noqa: E501
Add a new template. # noqa: E501
"""
(data) = self.add_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,731 |
mailchimp_transactional.api.templates_api
|
add_with_http_info
|
Add template # noqa: E501
Add a new template. # noqa: E501
|
def add_with_http_info(self, body, **kwargs): # noqa: E501
"""Add template # noqa: E501
Add a new template. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 add" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/templates/add', 'POST',
body=body_params,
response_type='InlineResponse20060') # noqa: E501
|
(self, body, **kwargs)
|
62,732 |
mailchimp_transactional.api.templates_api
|
delete
|
Delete template # noqa: E501
Delete a template. # noqa: E501
|
def delete(self, body = {}, **kwargs): # noqa: E501
"""Delete template # noqa: E501
Delete a template. # noqa: E501
"""
(data) = self.delete_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,733 |
mailchimp_transactional.api.templates_api
|
delete_with_http_info
|
Delete template # noqa: E501
Delete a template. # noqa: E501
|
def delete_with_http_info(self, body, **kwargs): # noqa: E501
"""Delete template # noqa: E501
Delete a template. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 delete" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/templates/delete', 'POST',
body=body_params,
response_type='InlineResponse20064') # noqa: E501
|
(self, body, **kwargs)
|
62,734 |
mailchimp_transactional.api.templates_api
|
info
|
Get template info # noqa: E501
Get the information for an existing template. # noqa: E501
|
def info(self, body = {}, **kwargs): # noqa: E501
"""Get template info # noqa: E501
Get the information for an existing template. # noqa: E501
"""
(data) = self.info_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,735 |
mailchimp_transactional.api.templates_api
|
info_with_http_info
|
Get template info # noqa: E501
Get the information for an existing template. # noqa: E501
|
def info_with_http_info(self, body, **kwargs): # noqa: E501
"""Get template info # noqa: E501
Get the information for an existing template. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 info" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/templates/info', 'POST',
body=body_params,
response_type='InlineResponse20061') # noqa: E501
|
(self, body, **kwargs)
|
62,736 |
mailchimp_transactional.api.templates_api
|
list
|
List templates # noqa: E501
Return a list of all the templates available to this user. # noqa: E501
|
def list(self, body = {}, **kwargs): # noqa: E501
"""List templates # noqa: E501
Return a list of all the templates available to this user. # noqa: E501
"""
(data) = self.list_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,737 |
mailchimp_transactional.api.templates_api
|
list_with_http_info
|
List templates # noqa: E501
Return a list of all the templates available to this user. # noqa: E501
|
def list_with_http_info(self, body, **kwargs): # noqa: E501
"""List templates # noqa: E501
Return a list of all the templates available to this user. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 list" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/templates/list', 'POST',
body=body_params,
response_type='list[InlineResponse20065]') # noqa: E501
|
(self, body, **kwargs)
|
62,738 |
mailchimp_transactional.api.templates_api
|
publish
|
Publish template content # noqa: E501
Publish the content for the template. Any new messages sent using this template will start using the content that was previously in draft. # noqa: E501
|
def publish(self, body = {}, **kwargs): # noqa: E501
"""Publish template content # noqa: E501
Publish the content for the template. Any new messages sent using this template will start using the content that was previously in draft. # noqa: E501
"""
(data) = self.publish_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,739 |
mailchimp_transactional.api.templates_api
|
publish_with_http_info
|
Publish template content # noqa: E501
Publish the content for the template. Any new messages sent using this template will start using the content that was previously in draft. # noqa: E501
|
def publish_with_http_info(self, body, **kwargs): # noqa: E501
"""Publish template content # noqa: E501
Publish the content for the template. Any new messages sent using this template will start using the content that was previously in draft. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 publish" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/templates/publish', 'POST',
body=body_params,
response_type='InlineResponse20063') # noqa: E501
|
(self, body, **kwargs)
|
62,740 |
mailchimp_transactional.api.templates_api
|
render
|
Render html template # noqa: E501
Inject content and optionally merge fields into a template, returning the HTML that results. # noqa: E501
|
def render(self, body = {}, **kwargs): # noqa: E501
"""Render html template # noqa: E501
Inject content and optionally merge fields into a template, returning the HTML that results. # noqa: E501
"""
(data) = self.render_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,741 |
mailchimp_transactional.api.templates_api
|
render_with_http_info
|
Render html template # noqa: E501
Inject content and optionally merge fields into a template, returning the HTML that results. # noqa: E501
|
def render_with_http_info(self, body, **kwargs): # noqa: E501
"""Render html template # noqa: E501
Inject content and optionally merge fields into a template, returning the HTML that results. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 render" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/templates/render', 'POST',
body=body_params,
response_type='InlineResponse20066') # noqa: E501
|
(self, body, **kwargs)
|
62,742 |
mailchimp_transactional.api.templates_api
|
time_series
|
Get template history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a template. # noqa: E501
|
def time_series(self, body = {}, **kwargs): # noqa: E501
"""Get template history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a template. # noqa: E501
"""
(data) = self.time_series_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,743 |
mailchimp_transactional.api.templates_api
|
time_series_with_http_info
|
Get template history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a template. # noqa: E501
|
def time_series_with_http_info(self, body, **kwargs): # noqa: E501
"""Get template history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a template. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 time_series" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/templates/time-series', 'POST',
body=body_params,
response_type='list[InlineResponse20049]') # noqa: E501
|
(self, body, **kwargs)
|
62,744 |
mailchimp_transactional.api.templates_api
|
update
|
Update template # noqa: E501
Update the code for an existing template. If null is provided for any fields, the values will remain unchanged. # noqa: E501
|
def update(self, body = {}, **kwargs): # noqa: E501
"""Update template # noqa: E501
Update the code for an existing template. If null is provided for any fields, the values will remain unchanged. # noqa: E501
"""
(data) = self.update_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,745 |
mailchimp_transactional.api.templates_api
|
update_with_http_info
|
Update template # noqa: E501
Update the code for an existing template. If null is provided for any fields, the values will remain unchanged. # noqa: E501
|
def update_with_http_info(self, body, **kwargs): # noqa: E501
"""Update template # noqa: E501
Update the code for an existing template. If null is provided for any fields, the values will remain unchanged. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 update" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/templates/update', 'POST',
body=body_params,
response_type='InlineResponse20062') # noqa: E501
|
(self, body, **kwargs)
|
62,746 |
mailchimp_transactional.api.urls_api
|
UrlsApi
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
|
class UrlsApi(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""
def __init__(self, api_key='', api_client = None):
self.api_key = api_key
if api_client:
self.api_client = api_client
else:
self.api_client = ApiClient()
def add_tracking_domain(self, body = {}, **kwargs): # noqa: E501
"""Add tracking domains # noqa: E501
Add a tracking domain to your account. # noqa: E501
"""
(data) = self.add_tracking_domain_with_http_info(body, **kwargs) # noqa: E501
return data
def add_tracking_domain_with_http_info(self, body, **kwargs): # noqa: E501
"""Add tracking domains # noqa: E501
Add a tracking domain to your account. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 add_tracking_domain" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/urls/add-tracking-domain', 'POST',
body=body_params,
response_type='InlineResponse20071') # noqa: E501
def check_tracking_domain(self, body = {}, **kwargs): # noqa: E501
"""Check cname settings # noqa: E501
Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call. # noqa: E501
"""
(data) = self.check_tracking_domain_with_http_info(body, **kwargs) # noqa: E501
return data
def check_tracking_domain_with_http_info(self, body, **kwargs): # noqa: E501
"""Check cname settings # noqa: E501
Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 check_tracking_domain" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/urls/check-tracking-domain', 'POST',
body=body_params,
response_type='InlineResponse20071') # noqa: E501
def list(self, body = {}, **kwargs): # noqa: E501
"""List most clicked urls # noqa: E501
Get the 100 most clicked URLs. # noqa: E501
"""
(data) = self.list_with_http_info(body, **kwargs) # noqa: E501
return data
def list_with_http_info(self, body, **kwargs): # noqa: E501
"""List most clicked urls # noqa: E501
Get the 100 most clicked URLs. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 list" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/urls/list', 'POST',
body=body_params,
response_type='list[InlineResponse20067]') # noqa: E501
def search(self, body = {}, **kwargs): # noqa: E501
"""Search most clicked urls # noqa: E501
Return the 100 most clicked URLs that match the search query given. # noqa: E501
"""
(data) = self.search_with_http_info(body, **kwargs) # noqa: E501
return data
def search_with_http_info(self, body, **kwargs): # noqa: E501
"""Search most clicked urls # noqa: E501
Return the 100 most clicked URLs that match the search query given. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 search" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/urls/search', 'POST',
body=body_params,
response_type='list[InlineResponse20068]') # noqa: E501
def time_series(self, body = {}, **kwargs): # noqa: E501
"""Get url history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a URL # noqa: E501
"""
(data) = self.time_series_with_http_info(body, **kwargs) # noqa: E501
return data
def time_series_with_http_info(self, body, **kwargs): # noqa: E501
"""Get url history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a URL # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 time_series" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/urls/time-series', 'POST',
body=body_params,
response_type='list[InlineResponse20069]') # noqa: E501
def tracking_domains(self, body = {}, **kwargs): # noqa: E501
"""List tracking domains # noqa: E501
Get the list of tracking domains set up for this account. # noqa: E501
"""
(data) = self.tracking_domains_with_http_info(body, **kwargs) # noqa: E501
return data
def tracking_domains_with_http_info(self, body, **kwargs): # noqa: E501
"""List tracking domains # noqa: E501
Get the list of tracking domains set up for this account. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 tracking_domains" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/urls/tracking-domains', 'POST',
body=body_params,
response_type='list[InlineResponse20070]') # noqa: E501
|
(api_key='', api_client=None)
|
62,748 |
mailchimp_transactional.api.urls_api
|
add_tracking_domain
|
Add tracking domains # noqa: E501
Add a tracking domain to your account. # noqa: E501
|
def add_tracking_domain(self, body = {}, **kwargs): # noqa: E501
"""Add tracking domains # noqa: E501
Add a tracking domain to your account. # noqa: E501
"""
(data) = self.add_tracking_domain_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,749 |
mailchimp_transactional.api.urls_api
|
add_tracking_domain_with_http_info
|
Add tracking domains # noqa: E501
Add a tracking domain to your account. # noqa: E501
|
def add_tracking_domain_with_http_info(self, body, **kwargs): # noqa: E501
"""Add tracking domains # noqa: E501
Add a tracking domain to your account. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 add_tracking_domain" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/urls/add-tracking-domain', 'POST',
body=body_params,
response_type='InlineResponse20071') # noqa: E501
|
(self, body, **kwargs)
|
62,750 |
mailchimp_transactional.api.urls_api
|
check_tracking_domain
|
Check cname settings # noqa: E501
Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call. # noqa: E501
|
def check_tracking_domain(self, body = {}, **kwargs): # noqa: E501
"""Check cname settings # noqa: E501
Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call. # noqa: E501
"""
(data) = self.check_tracking_domain_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,751 |
mailchimp_transactional.api.urls_api
|
check_tracking_domain_with_http_info
|
Check cname settings # noqa: E501
Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call. # noqa: E501
|
def check_tracking_domain_with_http_info(self, body, **kwargs): # noqa: E501
"""Check cname settings # noqa: E501
Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 check_tracking_domain" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/urls/check-tracking-domain', 'POST',
body=body_params,
response_type='InlineResponse20071') # noqa: E501
|
(self, body, **kwargs)
|
62,752 |
mailchimp_transactional.api.urls_api
|
list
|
List most clicked urls # noqa: E501
Get the 100 most clicked URLs. # noqa: E501
|
def list(self, body = {}, **kwargs): # noqa: E501
"""List most clicked urls # noqa: E501
Get the 100 most clicked URLs. # noqa: E501
"""
(data) = self.list_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,753 |
mailchimp_transactional.api.urls_api
|
list_with_http_info
|
List most clicked urls # noqa: E501
Get the 100 most clicked URLs. # noqa: E501
|
def list_with_http_info(self, body, **kwargs): # noqa: E501
"""List most clicked urls # noqa: E501
Get the 100 most clicked URLs. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 list" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/urls/list', 'POST',
body=body_params,
response_type='list[InlineResponse20067]') # noqa: E501
|
(self, body, **kwargs)
|
62,754 |
mailchimp_transactional.api.urls_api
|
search
|
Search most clicked urls # noqa: E501
Return the 100 most clicked URLs that match the search query given. # noqa: E501
|
def search(self, body = {}, **kwargs): # noqa: E501
"""Search most clicked urls # noqa: E501
Return the 100 most clicked URLs that match the search query given. # noqa: E501
"""
(data) = self.search_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,755 |
mailchimp_transactional.api.urls_api
|
search_with_http_info
|
Search most clicked urls # noqa: E501
Return the 100 most clicked URLs that match the search query given. # noqa: E501
|
def search_with_http_info(self, body, **kwargs): # noqa: E501
"""Search most clicked urls # noqa: E501
Return the 100 most clicked URLs that match the search query given. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 search" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/urls/search', 'POST',
body=body_params,
response_type='list[InlineResponse20068]') # noqa: E501
|
(self, body, **kwargs)
|
62,756 |
mailchimp_transactional.api.urls_api
|
time_series
|
Get url history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a URL # noqa: E501
|
def time_series(self, body = {}, **kwargs): # noqa: E501
"""Get url history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a URL # noqa: E501
"""
(data) = self.time_series_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,757 |
mailchimp_transactional.api.urls_api
|
time_series_with_http_info
|
Get url history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a URL # noqa: E501
|
def time_series_with_http_info(self, body, **kwargs): # noqa: E501
"""Get url history # noqa: E501
Return the recent history (hourly stats for the last 30 days) for a URL # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 time_series" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/urls/time-series', 'POST',
body=body_params,
response_type='list[InlineResponse20069]') # noqa: E501
|
(self, body, **kwargs)
|
62,758 |
mailchimp_transactional.api.urls_api
|
tracking_domains
|
List tracking domains # noqa: E501
Get the list of tracking domains set up for this account. # noqa: E501
|
def tracking_domains(self, body = {}, **kwargs): # noqa: E501
"""List tracking domains # noqa: E501
Get the list of tracking domains set up for this account. # noqa: E501
"""
(data) = self.tracking_domains_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,759 |
mailchimp_transactional.api.urls_api
|
tracking_domains_with_http_info
|
List tracking domains # noqa: E501
Get the list of tracking domains set up for this account. # noqa: E501
|
def tracking_domains_with_http_info(self, body, **kwargs): # noqa: E501
"""List tracking domains # noqa: E501
Get the list of tracking domains set up for this account. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 tracking_domains" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/urls/tracking-domains', 'POST',
body=body_params,
response_type='list[InlineResponse20070]') # noqa: E501
|
(self, body, **kwargs)
|
62,760 |
mailchimp_transactional.api.users_api
|
UsersApi
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
|
class UsersApi(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""
def __init__(self, api_key='', api_client = None):
self.api_key = api_key
if api_client:
self.api_client = api_client
else:
self.api_client = ApiClient()
def info(self, body = {}, **kwargs): # noqa: E501
"""Get user info # noqa: E501
Return the information about the API-connected user. # noqa: E501
"""
(data) = self.info_with_http_info(body, **kwargs) # noqa: E501
return data
def info_with_http_info(self, body, **kwargs): # noqa: E501
"""Get user info # noqa: E501
Return the information about the API-connected user. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 info" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/users/info', 'POST',
body=body_params,
response_type='InlineResponse20072') # noqa: E501
def ping(self, body = {}, **kwargs): # noqa: E501
"""Ping # noqa: E501
Validate an API key and respond to a ping. # noqa: E501
"""
(data) = self.ping_with_http_info(body, **kwargs) # noqa: E501
return data
def ping_with_http_info(self, body, **kwargs): # noqa: E501
"""Ping # noqa: E501
Validate an API key and respond to a ping. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 ping" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/users/ping', 'POST',
body=body_params,
response_type='str') # noqa: E501
def ping2(self, body = {}, **kwargs): # noqa: E501
"""Ping 2 # noqa: E501
Validate an API key and respond to a ping (JSON parser version). # noqa: E501
"""
(data) = self.ping2_with_http_info(body, **kwargs) # noqa: E501
return data
def ping2_with_http_info(self, body, **kwargs): # noqa: E501
"""Ping 2 # noqa: E501
Validate an API key and respond to a ping (JSON parser version). # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 ping2" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/users/ping2', 'POST',
body=body_params,
response_type='InlineResponse20073') # noqa: E501
def senders(self, body = {}, **kwargs): # noqa: E501
"""List account senders # noqa: E501
Return the senders that have tried to use this account, both verified and unverified. # noqa: E501
"""
(data) = self.senders_with_http_info(body, **kwargs) # noqa: E501
return data
def senders_with_http_info(self, body, **kwargs): # noqa: E501
"""List account senders # noqa: E501
Return the senders that have tried to use this account, both verified and unverified. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 senders" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/users/senders', 'POST',
body=body_params,
response_type='list[InlineResponse20043]') # noqa: E501
|
(api_key='', api_client=None)
|
62,762 |
mailchimp_transactional.api.users_api
|
info
|
Get user info # noqa: E501
Return the information about the API-connected user. # noqa: E501
|
def info(self, body = {}, **kwargs): # noqa: E501
"""Get user info # noqa: E501
Return the information about the API-connected user. # noqa: E501
"""
(data) = self.info_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,763 |
mailchimp_transactional.api.users_api
|
info_with_http_info
|
Get user info # noqa: E501
Return the information about the API-connected user. # noqa: E501
|
def info_with_http_info(self, body, **kwargs): # noqa: E501
"""Get user info # noqa: E501
Return the information about the API-connected user. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 info" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/users/info', 'POST',
body=body_params,
response_type='InlineResponse20072') # noqa: E501
|
(self, body, **kwargs)
|
62,764 |
mailchimp_transactional.api.users_api
|
ping
|
Ping # noqa: E501
Validate an API key and respond to a ping. # noqa: E501
|
def ping(self, body = {}, **kwargs): # noqa: E501
"""Ping # noqa: E501
Validate an API key and respond to a ping. # noqa: E501
"""
(data) = self.ping_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,765 |
mailchimp_transactional.api.users_api
|
ping2
|
Ping 2 # noqa: E501
Validate an API key and respond to a ping (JSON parser version). # noqa: E501
|
def ping2(self, body = {}, **kwargs): # noqa: E501
"""Ping 2 # noqa: E501
Validate an API key and respond to a ping (JSON parser version). # noqa: E501
"""
(data) = self.ping2_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,766 |
mailchimp_transactional.api.users_api
|
ping2_with_http_info
|
Ping 2 # noqa: E501
Validate an API key and respond to a ping (JSON parser version). # noqa: E501
|
def ping2_with_http_info(self, body, **kwargs): # noqa: E501
"""Ping 2 # noqa: E501
Validate an API key and respond to a ping (JSON parser version). # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 ping2" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/users/ping2', 'POST',
body=body_params,
response_type='InlineResponse20073') # noqa: E501
|
(self, body, **kwargs)
|
62,767 |
mailchimp_transactional.api.users_api
|
ping_with_http_info
|
Ping # noqa: E501
Validate an API key and respond to a ping. # noqa: E501
|
def ping_with_http_info(self, body, **kwargs): # noqa: E501
"""Ping # noqa: E501
Validate an API key and respond to a ping. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 ping" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/users/ping', 'POST',
body=body_params,
response_type='str') # noqa: E501
|
(self, body, **kwargs)
|
62,768 |
mailchimp_transactional.api.users_api
|
senders
|
List account senders # noqa: E501
Return the senders that have tried to use this account, both verified and unverified. # noqa: E501
|
def senders(self, body = {}, **kwargs): # noqa: E501
"""List account senders # noqa: E501
Return the senders that have tried to use this account, both verified and unverified. # noqa: E501
"""
(data) = self.senders_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,769 |
mailchimp_transactional.api.users_api
|
senders_with_http_info
|
List account senders # noqa: E501
Return the senders that have tried to use this account, both verified and unverified. # noqa: E501
|
def senders_with_http_info(self, body, **kwargs): # noqa: E501
"""List account senders # noqa: E501
Return the senders that have tried to use this account, both verified and unverified. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 senders" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/users/senders', 'POST',
body=body_params,
response_type='list[InlineResponse20043]') # noqa: E501
|
(self, body, **kwargs)
|
62,770 |
mailchimp_transactional.api.webhooks_api
|
WebhooksApi
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
|
class WebhooksApi(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""
def __init__(self, api_key='', api_client = None):
self.api_key = api_key
if api_client:
self.api_client = api_client
else:
self.api_client = ApiClient()
def add(self, body = {}, **kwargs): # noqa: E501
"""Add webhook # noqa: E501
Add a new webhook. # noqa: E501
"""
(data) = self.add_with_http_info(body, **kwargs) # noqa: E501
return data
def add_with_http_info(self, body, **kwargs): # noqa: E501
"""Add webhook # noqa: E501
Add a new webhook. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 add" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/webhooks/add', 'POST',
body=body_params,
response_type='InlineResponse20075') # noqa: E501
def delete(self, body = {}, **kwargs): # noqa: E501
"""Delete webhook # noqa: E501
Delete an existing webhook. # noqa: E501
"""
(data) = self.delete_with_http_info(body, **kwargs) # noqa: E501
return data
def delete_with_http_info(self, body, **kwargs): # noqa: E501
"""Delete webhook # noqa: E501
Delete an existing webhook. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 delete" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/webhooks/delete', 'POST',
body=body_params,
response_type='InlineResponse20078') # noqa: E501
def info(self, body = {}, **kwargs): # noqa: E501
"""Get webhook info # noqa: E501
Given the ID of an existing webhook, return the data about it. # noqa: E501
"""
(data) = self.info_with_http_info(body, **kwargs) # noqa: E501
return data
def info_with_http_info(self, body, **kwargs): # noqa: E501
"""Get webhook info # noqa: E501
Given the ID of an existing webhook, return the data about it. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 info" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/webhooks/info', 'POST',
body=body_params,
response_type='InlineResponse20076') # noqa: E501
def list(self, body = {}, **kwargs): # noqa: E501
"""List webhooks # noqa: E501
Get the list of all webhooks defined on the account. # noqa: E501
"""
(data) = self.list_with_http_info(body, **kwargs) # noqa: E501
return data
def list_with_http_info(self, body, **kwargs): # noqa: E501
"""List webhooks # noqa: E501
Get the list of all webhooks defined on the account. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 list" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/webhooks/list', 'POST',
body=body_params,
response_type='list[InlineResponse20074]') # noqa: E501
def update(self, body = {}, **kwargs): # noqa: E501
"""Update webhook # noqa: E501
Update an existing webhook. # noqa: E501
"""
(data) = self.update_with_http_info(body, **kwargs) # noqa: E501
return data
def update_with_http_info(self, body, **kwargs): # noqa: E501
"""Update webhook # noqa: E501
Update an existing webhook. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 update" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/webhooks/update', 'POST',
body=body_params,
response_type='InlineResponse20077') # noqa: E501
|
(api_key='', api_client=None)
|
62,772 |
mailchimp_transactional.api.webhooks_api
|
add
|
Add webhook # noqa: E501
Add a new webhook. # noqa: E501
|
def add(self, body = {}, **kwargs): # noqa: E501
"""Add webhook # noqa: E501
Add a new webhook. # noqa: E501
"""
(data) = self.add_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,773 |
mailchimp_transactional.api.webhooks_api
|
add_with_http_info
|
Add webhook # noqa: E501
Add a new webhook. # noqa: E501
|
def add_with_http_info(self, body, **kwargs): # noqa: E501
"""Add webhook # noqa: E501
Add a new webhook. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 add" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/webhooks/add', 'POST',
body=body_params,
response_type='InlineResponse20075') # noqa: E501
|
(self, body, **kwargs)
|
62,774 |
mailchimp_transactional.api.webhooks_api
|
delete
|
Delete webhook # noqa: E501
Delete an existing webhook. # noqa: E501
|
def delete(self, body = {}, **kwargs): # noqa: E501
"""Delete webhook # noqa: E501
Delete an existing webhook. # noqa: E501
"""
(data) = self.delete_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,775 |
mailchimp_transactional.api.webhooks_api
|
delete_with_http_info
|
Delete webhook # noqa: E501
Delete an existing webhook. # noqa: E501
|
def delete_with_http_info(self, body, **kwargs): # noqa: E501
"""Delete webhook # noqa: E501
Delete an existing webhook. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 delete" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/webhooks/delete', 'POST',
body=body_params,
response_type='InlineResponse20078') # noqa: E501
|
(self, body, **kwargs)
|
62,776 |
mailchimp_transactional.api.webhooks_api
|
info
|
Get webhook info # noqa: E501
Given the ID of an existing webhook, return the data about it. # noqa: E501
|
def info(self, body = {}, **kwargs): # noqa: E501
"""Get webhook info # noqa: E501
Given the ID of an existing webhook, return the data about it. # noqa: E501
"""
(data) = self.info_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,777 |
mailchimp_transactional.api.webhooks_api
|
info_with_http_info
|
Get webhook info # noqa: E501
Given the ID of an existing webhook, return the data about it. # noqa: E501
|
def info_with_http_info(self, body, **kwargs): # noqa: E501
"""Get webhook info # noqa: E501
Given the ID of an existing webhook, return the data about it. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 info" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/webhooks/info', 'POST',
body=body_params,
response_type='InlineResponse20076') # noqa: E501
|
(self, body, **kwargs)
|
62,778 |
mailchimp_transactional.api.webhooks_api
|
list
|
List webhooks # noqa: E501
Get the list of all webhooks defined on the account. # noqa: E501
|
def list(self, body = {}, **kwargs): # noqa: E501
"""List webhooks # noqa: E501
Get the list of all webhooks defined on the account. # noqa: E501
"""
(data) = self.list_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,779 |
mailchimp_transactional.api.webhooks_api
|
list_with_http_info
|
List webhooks # noqa: E501
Get the list of all webhooks defined on the account. # noqa: E501
|
def list_with_http_info(self, body, **kwargs): # noqa: E501
"""List webhooks # noqa: E501
Get the list of all webhooks defined on the account. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 list" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/webhooks/list', 'POST',
body=body_params,
response_type='list[InlineResponse20074]') # noqa: E501
|
(self, body, **kwargs)
|
62,780 |
mailchimp_transactional.api.webhooks_api
|
update
|
Update webhook # noqa: E501
Update an existing webhook. # noqa: E501
|
def update(self, body = {}, **kwargs): # noqa: E501
"""Update webhook # noqa: E501
Update an existing webhook. # noqa: E501
"""
(data) = self.update_with_http_info(body, **kwargs) # noqa: E501
return data
|
(self, body={}, **kwargs)
|
62,781 |
mailchimp_transactional.api.webhooks_api
|
update_with_http_info
|
Update webhook # noqa: E501
Update an existing webhook. # noqa: E501
|
def update_with_http_info(self, body, **kwargs): # noqa: E501
"""Update webhook # noqa: E501
Update an existing webhook. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 update" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/webhooks/update', 'POST',
body=body_params,
response_type='InlineResponse20077') # noqa: E501
|
(self, body, **kwargs)
|
62,782 |
mailchimp_transactional.api.whitelists_api
|
WhitelistsApi
|
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
|
class WhitelistsApi(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""
def __init__(self, api_key='', api_client = None):
self.api_key = api_key
if api_client:
self.api_client = api_client
else:
self.api_client = ApiClient()
def add(self, body = {}, **kwargs): # noqa: E501
"""Add email to allowlist # noqa: E501
Adds an email to your email rejection allowlist. If the address is currently on your denylist, that denylist entry will be removed automatically. # noqa: E501
"""
(data) = self.add_with_http_info(body, **kwargs) # noqa: E501
return data
def add_with_http_info(self, body, **kwargs): # noqa: E501
"""Add email to allowlist # noqa: E501
Adds an email to your email rejection allowlist. If the address is currently on your denylist, that denylist entry will be removed automatically. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 add" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/whitelists/add', 'POST',
body=body_params,
response_type='InlineResponse200') # noqa: E501
def delete(self, body = {}, **kwargs): # noqa: E501
"""Remove email from allowlist # noqa: E501
Removes an email address from the allowlist. # noqa: E501
"""
(data) = self.delete_with_http_info(body, **kwargs) # noqa: E501
return data
def delete_with_http_info(self, body, **kwargs): # noqa: E501
"""Remove email from allowlist # noqa: E501
Removes an email address from the allowlist. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 delete" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/whitelists/delete', 'POST',
body=body_params,
response_type='InlineResponse2002') # noqa: E501
def list(self, body = {}, **kwargs): # noqa: E501
"""List allowlisted emails # noqa: E501
Retrieves your email rejection allowlist. You can provide an email address or search prefix to limit the results. Returns up to 1000 results. # noqa: E501
"""
(data) = self.list_with_http_info(body, **kwargs) # noqa: E501
return data
def list_with_http_info(self, body, **kwargs): # noqa: E501
"""List allowlisted emails # noqa: E501
Retrieves your email rejection allowlist. You can provide an email address or search prefix to limit the results. Returns up to 1000 results. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 list" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/whitelists/list', 'POST',
body=body_params,
response_type='list[InlineResponse2001]') # noqa: E501
|
(api_key='', api_client=None)
|
62,785 |
mailchimp_transactional.api.whitelists_api
|
add_with_http_info
|
Add email to allowlist # noqa: E501
Adds an email to your email rejection allowlist. If the address is currently on your denylist, that denylist entry will be removed automatically. # noqa: E501
|
def add_with_http_info(self, body, **kwargs): # noqa: E501
"""Add email to allowlist # noqa: E501
Adds an email to your email rejection allowlist. If the address is currently on your denylist, that denylist entry will be removed automatically. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 add" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/whitelists/add', 'POST',
body=body_params,
response_type='InlineResponse200') # noqa: E501
|
(self, body, **kwargs)
|
62,787 |
mailchimp_transactional.api.whitelists_api
|
delete_with_http_info
|
Remove email from allowlist # noqa: E501
Removes an email address from the allowlist. # noqa: E501
|
def delete_with_http_info(self, body, **kwargs): # noqa: E501
"""Remove email from allowlist # noqa: E501
Removes an email address from the allowlist. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 delete" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/whitelists/delete', 'POST',
body=body_params,
response_type='InlineResponse2002') # noqa: E501
|
(self, body, **kwargs)
|
62,789 |
mailchimp_transactional.api.whitelists_api
|
list_with_http_info
|
List allowlisted emails # noqa: E501
Retrieves your email rejection allowlist. You can provide an email address or search prefix to limit the results. Returns up to 1000 results. # noqa: E501
|
def list_with_http_info(self, body, **kwargs): # noqa: E501
"""List allowlisted emails # noqa: E501
Retrieves your email rejection allowlist. You can provide an email address or search prefix to limit the results. Returns up to 1000 results. # noqa: E501
"""
all_params = ['body'] # noqa: E501
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 list" % key
)
params[key] = val
del params['kwargs']
# add api_key to body params
params['body']['key'] = self.api_key
body_params = None
if 'body' in params:
body_params = params['body']
return self.api_client.call_api(
'/whitelists/list', 'POST',
body=body_params,
response_type='list[InlineResponse2001]') # noqa: E501
|
(self, body, **kwargs)
|
62,792 |
litellm.llms.ai21
|
AI21Config
|
Reference: https://docs.ai21.com/reference/j2-complete-ref
The class `AI21Config` provides configuration for the AI21's API interface. Below are the parameters:
- `numResults` (int32): Number of completions to sample and return. Optional, default is 1. If the temperature is greater than 0 (non-greedy decoding), a value greater than 1 can be meaningful.
- `maxTokens` (int32): The maximum number of tokens to generate per result. Optional, default is 16. If no `stopSequences` are given, generation stops after producing `maxTokens`.
- `minTokens` (int32): The minimum number of tokens to generate per result. Optional, default is 0. If `stopSequences` are given, they are ignored until `minTokens` are generated.
- `temperature` (float): Modifies the distribution from which tokens are sampled. Optional, default is 0.7. A value of 0 essentially disables sampling and results in greedy decoding.
- `topP` (float): Used for sampling tokens from the corresponding top percentile of probability mass. Optional, default is 1. For instance, a value of 0.9 considers only tokens comprising the top 90% probability mass.
- `stopSequences` (array of strings): Stops decoding if any of the input strings is generated. Optional.
- `topKReturn` (int32): Range between 0 to 10, including both. Optional, default is 0. Specifies the top-K alternative tokens to return. A non-zero value includes the string representations and log-probabilities for each of the top-K alternatives at each position.
- `frequencyPenalty` (object): Placeholder for frequency penalty object.
- `presencePenalty` (object): Placeholder for presence penalty object.
- `countPenalty` (object): Placeholder for count penalty object.
|
class AI21Config:
"""
Reference: https://docs.ai21.com/reference/j2-complete-ref
The class `AI21Config` provides configuration for the AI21's API interface. Below are the parameters:
- `numResults` (int32): Number of completions to sample and return. Optional, default is 1. If the temperature is greater than 0 (non-greedy decoding), a value greater than 1 can be meaningful.
- `maxTokens` (int32): The maximum number of tokens to generate per result. Optional, default is 16. If no `stopSequences` are given, generation stops after producing `maxTokens`.
- `minTokens` (int32): The minimum number of tokens to generate per result. Optional, default is 0. If `stopSequences` are given, they are ignored until `minTokens` are generated.
- `temperature` (float): Modifies the distribution from which tokens are sampled. Optional, default is 0.7. A value of 0 essentially disables sampling and results in greedy decoding.
- `topP` (float): Used for sampling tokens from the corresponding top percentile of probability mass. Optional, default is 1. For instance, a value of 0.9 considers only tokens comprising the top 90% probability mass.
- `stopSequences` (array of strings): Stops decoding if any of the input strings is generated. Optional.
- `topKReturn` (int32): Range between 0 to 10, including both. Optional, default is 0. Specifies the top-K alternative tokens to return. A non-zero value includes the string representations and log-probabilities for each of the top-K alternatives at each position.
- `frequencyPenalty` (object): Placeholder for frequency penalty object.
- `presencePenalty` (object): Placeholder for presence penalty object.
- `countPenalty` (object): Placeholder for count penalty object.
"""
numResults: Optional[int] = None
maxTokens: Optional[int] = None
minTokens: Optional[int] = None
temperature: Optional[float] = None
topP: Optional[float] = None
stopSequences: Optional[list] = None
topKReturn: Optional[int] = None
frequencePenalty: Optional[dict] = None
presencePenalty: Optional[dict] = None
countPenalty: Optional[dict] = None
def __init__(
self,
numResults: Optional[int] = None,
maxTokens: Optional[int] = None,
minTokens: Optional[int] = None,
temperature: Optional[float] = None,
topP: Optional[float] = None,
stopSequences: Optional[list] = None,
topKReturn: Optional[int] = None,
frequencePenalty: Optional[dict] = None,
presencePenalty: Optional[dict] = None,
countPenalty: Optional[dict] = None,
) -> None:
locals_ = locals()
for key, value in locals_.items():
if key != "self" and value is not None:
setattr(self.__class__, key, value)
@classmethod
def get_config(cls):
return {
k: v
for k, v in cls.__dict__.items()
if not k.startswith("__")
and not isinstance(
v,
(
types.FunctionType,
types.BuiltinFunctionType,
classmethod,
staticmethod,
),
)
and v is not None
}
|
(numResults: Optional[int] = None, maxTokens: Optional[int] = None, minTokens: Optional[int] = None, temperature: Optional[float] = None, topP: Optional[float] = None, stopSequences: Optional[list] = None, topKReturn: Optional[int] = None, frequencePenalty: Optional[dict] = None, presencePenalty: Optional[dict] = None, countPenalty: Optional[dict] = None) -> None
|
62,793 |
litellm.llms.ai21
|
__init__
| null |
def __init__(
self,
numResults: Optional[int] = None,
maxTokens: Optional[int] = None,
minTokens: Optional[int] = None,
temperature: Optional[float] = None,
topP: Optional[float] = None,
stopSequences: Optional[list] = None,
topKReturn: Optional[int] = None,
frequencePenalty: Optional[dict] = None,
presencePenalty: Optional[dict] = None,
countPenalty: Optional[dict] = None,
) -> None:
locals_ = locals()
for key, value in locals_.items():
if key != "self" and value is not None:
setattr(self.__class__, key, value)
|
(self, numResults: Optional[int] = None, maxTokens: Optional[int] = None, minTokens: Optional[int] = None, temperature: Optional[float] = None, topP: Optional[float] = None, stopSequences: Optional[list] = None, topKReturn: Optional[int] = None, frequencePenalty: Optional[dict] = None, presencePenalty: Optional[dict] = None, countPenalty: Optional[dict] = None) -> NoneType
|
62,794 |
litellm.exceptions
|
APIConnectionError
| null |
class APIConnectionError(openai.APIConnectionError): # type: ignore
def __init__(self, message, llm_provider, model, request: httpx.Request):
self.message = message
self.llm_provider = llm_provider
self.model = model
self.status_code = 500
super().__init__(message=self.message, request=request)
|
(message, llm_provider, model, request: httpx.Request)
|
62,795 |
litellm.exceptions
|
__init__
| null |
def __init__(self, message, llm_provider, model, request: httpx.Request):
self.message = message
self.llm_provider = llm_provider
self.model = model
self.status_code = 500
super().__init__(message=self.message, request=request)
|
(self, message, llm_provider, model, request: httpx.Request)
|
62,796 |
litellm.exceptions
|
APIError
| null |
class APIError(openai.APIError): # type: ignore
def __init__(
self, status_code, message, llm_provider, model, request: httpx.Request
):
self.status_code = status_code
self.message = message
self.llm_provider = llm_provider
self.model = model
super().__init__(self.message, request=request, body=None) # type: ignore
|
(status_code, message, llm_provider, model, request: httpx.Request)
|
62,797 |
litellm.exceptions
|
__init__
| null |
def __init__(
self, status_code, message, llm_provider, model, request: httpx.Request
):
self.status_code = status_code
self.message = message
self.llm_provider = llm_provider
self.model = model
super().__init__(self.message, request=request, body=None) # type: ignore
|
(self, status_code, message, llm_provider, model, request: httpx.Request)
|
62,798 |
litellm.exceptions
|
APIResponseValidationError
| null |
class APIResponseValidationError(openai.APIResponseValidationError): # type: ignore
def __init__(self, message, llm_provider, model):
self.message = message
self.llm_provider = llm_provider
self.model = model
request = httpx.Request(method="POST", url="https://api.openai.com/v1")
response = httpx.Response(status_code=500, request=request)
super().__init__(response=response, body=None, message=message)
|
(message, llm_provider, model)
|
62,799 |
litellm.exceptions
|
__init__
| null |
def __init__(self, message, llm_provider, model):
self.message = message
self.llm_provider = llm_provider
self.model = model
request = httpx.Request(method="POST", url="https://api.openai.com/v1")
response = httpx.Response(status_code=500, request=request)
super().__init__(response=response, body=None, message=message)
|
(self, message, llm_provider, model)
|
62,800 |
litellm.llms.aleph_alpha
|
AlephAlphaConfig
|
Reference: https://docs.aleph-alpha.com/api/complete/
The `AlephAlphaConfig` class represents the configuration for the Aleph Alpha API. Here are the properties:
- `maximum_tokens` (integer, required): The maximum number of tokens to be generated by the completion. The sum of input tokens and maximum tokens may not exceed 2048.
- `minimum_tokens` (integer, optional; default value: 0): Generate at least this number of tokens before an end-of-text token is generated.
- `echo` (boolean, optional; default value: false): Whether to echo the prompt in the completion.
- `temperature` (number, nullable; default value: 0): Adjusts how creatively the model generates outputs. Use combinations of temperature, top_k, and top_p sensibly.
- `top_k` (integer, nullable; default value: 0): Introduces randomness into token generation by considering the top k most likely options.
- `top_p` (number, nullable; default value: 0): Adds randomness by considering the smallest set of tokens whose cumulative probability exceeds top_p.
- `presence_penalty`, `frequency_penalty`, `sequence_penalty` (number, nullable; default value: 0): Various penalties that can reduce repetition.
- `sequence_penalty_min_length` (integer; default value: 2): Minimum number of tokens to be considered as a sequence.
- `repetition_penalties_include_prompt`, `repetition_penalties_include_completion`, `use_multiplicative_presence_penalty`,`use_multiplicative_frequency_penalty`,`use_multiplicative_sequence_penalty` (boolean, nullable; default value: false): Various settings that adjust how the repetition penalties are applied.
- `penalty_bias` (string, nullable): Text used in addition to the penalized tokens for repetition penalties.
- `penalty_exceptions` (string[], nullable): Strings that may be generated without penalty.
- `penalty_exceptions_include_stop_sequences` (boolean, nullable; default value: true): Include all stop_sequences in penalty_exceptions.
- `best_of` (integer, nullable; default value: 1): The number of completions will be generated on the server side.
- `n` (integer, nullable; default value: 1): The number of completions to return.
- `logit_bias` (object, nullable): Adjust the logit scores before sampling.
- `log_probs` (integer, nullable): Number of top log probabilities for each token generated.
- `stop_sequences` (string[], nullable): List of strings that will stop generation if they're generated.
- `tokens` (boolean, nullable; default value: false): Flag indicating whether individual tokens of the completion should be returned or not.
- `raw_completion` (boolean; default value: false): if True, the raw completion of the model will be returned.
- `disable_optimizations` (boolean, nullable; default value: false): Disables any applied optimizations to both your prompt and completion.
- `completion_bias_inclusion`, `completion_bias_exclusion` (string[], default value: []): Set of strings to bias the generation of tokens.
- `completion_bias_inclusion_first_token_only`, `completion_bias_exclusion_first_token_only` (boolean; default value: false): Consider only the first token for the completion_bias_inclusion/exclusion.
- `contextual_control_threshold` (number, nullable): Control over how similar tokens are controlled.
- `control_log_additive` (boolean; default value: true): Method of applying control to attention scores.
|
class AlephAlphaConfig:
"""
Reference: https://docs.aleph-alpha.com/api/complete/
The `AlephAlphaConfig` class represents the configuration for the Aleph Alpha API. Here are the properties:
- `maximum_tokens` (integer, required): The maximum number of tokens to be generated by the completion. The sum of input tokens and maximum tokens may not exceed 2048.
- `minimum_tokens` (integer, optional; default value: 0): Generate at least this number of tokens before an end-of-text token is generated.
- `echo` (boolean, optional; default value: false): Whether to echo the prompt in the completion.
- `temperature` (number, nullable; default value: 0): Adjusts how creatively the model generates outputs. Use combinations of temperature, top_k, and top_p sensibly.
- `top_k` (integer, nullable; default value: 0): Introduces randomness into token generation by considering the top k most likely options.
- `top_p` (number, nullable; default value: 0): Adds randomness by considering the smallest set of tokens whose cumulative probability exceeds top_p.
- `presence_penalty`, `frequency_penalty`, `sequence_penalty` (number, nullable; default value: 0): Various penalties that can reduce repetition.
- `sequence_penalty_min_length` (integer; default value: 2): Minimum number of tokens to be considered as a sequence.
- `repetition_penalties_include_prompt`, `repetition_penalties_include_completion`, `use_multiplicative_presence_penalty`,`use_multiplicative_frequency_penalty`,`use_multiplicative_sequence_penalty` (boolean, nullable; default value: false): Various settings that adjust how the repetition penalties are applied.
- `penalty_bias` (string, nullable): Text used in addition to the penalized tokens for repetition penalties.
- `penalty_exceptions` (string[], nullable): Strings that may be generated without penalty.
- `penalty_exceptions_include_stop_sequences` (boolean, nullable; default value: true): Include all stop_sequences in penalty_exceptions.
- `best_of` (integer, nullable; default value: 1): The number of completions will be generated on the server side.
- `n` (integer, nullable; default value: 1): The number of completions to return.
- `logit_bias` (object, nullable): Adjust the logit scores before sampling.
- `log_probs` (integer, nullable): Number of top log probabilities for each token generated.
- `stop_sequences` (string[], nullable): List of strings that will stop generation if they're generated.
- `tokens` (boolean, nullable; default value: false): Flag indicating whether individual tokens of the completion should be returned or not.
- `raw_completion` (boolean; default value: false): if True, the raw completion of the model will be returned.
- `disable_optimizations` (boolean, nullable; default value: false): Disables any applied optimizations to both your prompt and completion.
- `completion_bias_inclusion`, `completion_bias_exclusion` (string[], default value: []): Set of strings to bias the generation of tokens.
- `completion_bias_inclusion_first_token_only`, `completion_bias_exclusion_first_token_only` (boolean; default value: false): Consider only the first token for the completion_bias_inclusion/exclusion.
- `contextual_control_threshold` (number, nullable): Control over how similar tokens are controlled.
- `control_log_additive` (boolean; default value: true): Method of applying control to attention scores.
"""
maximum_tokens: Optional[int] = (
litellm.max_tokens
) # aleph alpha requires max tokens
minimum_tokens: Optional[int] = None
echo: Optional[bool] = None
temperature: Optional[int] = None
top_k: Optional[int] = None
top_p: Optional[int] = None
presence_penalty: Optional[int] = None
frequency_penalty: Optional[int] = None
sequence_penalty: Optional[int] = None
sequence_penalty_min_length: Optional[int] = None
repetition_penalties_include_prompt: Optional[bool] = None
repetition_penalties_include_completion: Optional[bool] = None
use_multiplicative_presence_penalty: Optional[bool] = None
use_multiplicative_frequency_penalty: Optional[bool] = None
use_multiplicative_sequence_penalty: Optional[bool] = None
penalty_bias: Optional[str] = None
penalty_exceptions_include_stop_sequences: Optional[bool] = None
best_of: Optional[int] = None
n: Optional[int] = None
logit_bias: Optional[dict] = None
log_probs: Optional[int] = None
stop_sequences: Optional[list] = None
tokens: Optional[bool] = None
raw_completion: Optional[bool] = None
disable_optimizations: Optional[bool] = None
completion_bias_inclusion: Optional[list] = None
completion_bias_exclusion: Optional[list] = None
completion_bias_inclusion_first_token_only: Optional[bool] = None
completion_bias_exclusion_first_token_only: Optional[bool] = None
contextual_control_threshold: Optional[int] = None
control_log_additive: Optional[bool] = None
def __init__(
self,
maximum_tokens: Optional[int] = None,
minimum_tokens: Optional[int] = None,
echo: Optional[bool] = None,
temperature: Optional[int] = None,
top_k: Optional[int] = None,
top_p: Optional[int] = None,
presence_penalty: Optional[int] = None,
frequency_penalty: Optional[int] = None,
sequence_penalty: Optional[int] = None,
sequence_penalty_min_length: Optional[int] = None,
repetition_penalties_include_prompt: Optional[bool] = None,
repetition_penalties_include_completion: Optional[bool] = None,
use_multiplicative_presence_penalty: Optional[bool] = None,
use_multiplicative_frequency_penalty: Optional[bool] = None,
use_multiplicative_sequence_penalty: Optional[bool] = None,
penalty_bias: Optional[str] = None,
penalty_exceptions_include_stop_sequences: Optional[bool] = None,
best_of: Optional[int] = None,
n: Optional[int] = None,
logit_bias: Optional[dict] = None,
log_probs: Optional[int] = None,
stop_sequences: Optional[list] = None,
tokens: Optional[bool] = None,
raw_completion: Optional[bool] = None,
disable_optimizations: Optional[bool] = None,
completion_bias_inclusion: Optional[list] = None,
completion_bias_exclusion: Optional[list] = None,
completion_bias_inclusion_first_token_only: Optional[bool] = None,
completion_bias_exclusion_first_token_only: Optional[bool] = None,
contextual_control_threshold: Optional[int] = None,
control_log_additive: Optional[bool] = None,
) -> None:
locals_ = locals()
for key, value in locals_.items():
if key != "self" and value is not None:
setattr(self.__class__, key, value)
@classmethod
def get_config(cls):
return {
k: v
for k, v in cls.__dict__.items()
if not k.startswith("__")
and not isinstance(
v,
(
types.FunctionType,
types.BuiltinFunctionType,
classmethod,
staticmethod,
),
)
and v is not None
}
|
(maximum_tokens: Optional[int] = None, minimum_tokens: Optional[int] = None, echo: Optional[bool] = None, temperature: Optional[int] = None, top_k: Optional[int] = None, top_p: Optional[int] = None, presence_penalty: Optional[int] = None, frequency_penalty: Optional[int] = None, sequence_penalty: Optional[int] = None, sequence_penalty_min_length: Optional[int] = None, repetition_penalties_include_prompt: Optional[bool] = None, repetition_penalties_include_completion: Optional[bool] = None, use_multiplicative_presence_penalty: Optional[bool] = None, use_multiplicative_frequency_penalty: Optional[bool] = None, use_multiplicative_sequence_penalty: Optional[bool] = None, penalty_bias: Optional[str] = None, penalty_exceptions_include_stop_sequences: Optional[bool] = None, best_of: Optional[int] = None, n: Optional[int] = None, logit_bias: Optional[dict] = None, log_probs: Optional[int] = None, stop_sequences: Optional[list] = None, tokens: Optional[bool] = None, raw_completion: Optional[bool] = None, disable_optimizations: Optional[bool] = None, completion_bias_inclusion: Optional[list] = None, completion_bias_exclusion: Optional[list] = None, completion_bias_inclusion_first_token_only: Optional[bool] = None, completion_bias_exclusion_first_token_only: Optional[bool] = None, contextual_control_threshold: Optional[int] = None, control_log_additive: Optional[bool] = None) -> None
|
62,801 |
litellm.llms.aleph_alpha
|
__init__
| null |
def __init__(
self,
maximum_tokens: Optional[int] = None,
minimum_tokens: Optional[int] = None,
echo: Optional[bool] = None,
temperature: Optional[int] = None,
top_k: Optional[int] = None,
top_p: Optional[int] = None,
presence_penalty: Optional[int] = None,
frequency_penalty: Optional[int] = None,
sequence_penalty: Optional[int] = None,
sequence_penalty_min_length: Optional[int] = None,
repetition_penalties_include_prompt: Optional[bool] = None,
repetition_penalties_include_completion: Optional[bool] = None,
use_multiplicative_presence_penalty: Optional[bool] = None,
use_multiplicative_frequency_penalty: Optional[bool] = None,
use_multiplicative_sequence_penalty: Optional[bool] = None,
penalty_bias: Optional[str] = None,
penalty_exceptions_include_stop_sequences: Optional[bool] = None,
best_of: Optional[int] = None,
n: Optional[int] = None,
logit_bias: Optional[dict] = None,
log_probs: Optional[int] = None,
stop_sequences: Optional[list] = None,
tokens: Optional[bool] = None,
raw_completion: Optional[bool] = None,
disable_optimizations: Optional[bool] = None,
completion_bias_inclusion: Optional[list] = None,
completion_bias_exclusion: Optional[list] = None,
completion_bias_inclusion_first_token_only: Optional[bool] = None,
completion_bias_exclusion_first_token_only: Optional[bool] = None,
contextual_control_threshold: Optional[int] = None,
control_log_additive: Optional[bool] = None,
) -> None:
locals_ = locals()
for key, value in locals_.items():
if key != "self" and value is not None:
setattr(self.__class__, key, value)
|
(self, maximum_tokens: Optional[int] = None, minimum_tokens: Optional[int] = None, echo: Optional[bool] = None, temperature: Optional[int] = None, top_k: Optional[int] = None, top_p: Optional[int] = None, presence_penalty: Optional[int] = None, frequency_penalty: Optional[int] = None, sequence_penalty: Optional[int] = None, sequence_penalty_min_length: Optional[int] = None, repetition_penalties_include_prompt: Optional[bool] = None, repetition_penalties_include_completion: Optional[bool] = None, use_multiplicative_presence_penalty: Optional[bool] = None, use_multiplicative_frequency_penalty: Optional[bool] = None, use_multiplicative_sequence_penalty: Optional[bool] = None, penalty_bias: Optional[str] = None, penalty_exceptions_include_stop_sequences: Optional[bool] = None, best_of: Optional[int] = None, n: Optional[int] = None, logit_bias: Optional[dict] = None, log_probs: Optional[int] = None, stop_sequences: Optional[list] = None, tokens: Optional[bool] = None, raw_completion: Optional[bool] = None, disable_optimizations: Optional[bool] = None, completion_bias_inclusion: Optional[list] = None, completion_bias_exclusion: Optional[list] = None, completion_bias_inclusion_first_token_only: Optional[bool] = None, completion_bias_exclusion_first_token_only: Optional[bool] = None, contextual_control_threshold: Optional[int] = None, control_log_additive: Optional[bool] = None) -> NoneType
|
62,802 |
litellm.types.router
|
AlertingConfig
|
Use this configure alerting for the router. Receive alerts on the following events
- LLM API Exceptions
- LLM Responses Too Slow
- LLM Requests Hanging
Args:
webhook_url: str - webhook url for alerting, slack provides a webhook url to send alerts to
alerting_threshold: Optional[float] = None - threshold for slow / hanging llm responses (in seconds)
|
class AlertingConfig(BaseModel):
"""
Use this configure alerting for the router. Receive alerts on the following events
- LLM API Exceptions
- LLM Responses Too Slow
- LLM Requests Hanging
Args:
webhook_url: str - webhook url for alerting, slack provides a webhook url to send alerts to
alerting_threshold: Optional[float] = None - threshold for slow / hanging llm responses (in seconds)
"""
webhook_url: str
alerting_threshold: Optional[float] = 300
|
(*, webhook_url: str, alerting_threshold: Optional[float] = 300) -> None
|
62,831 |
litellm.llms.bedrock
|
AmazonAI21Config
|
Reference: https://us-west-2.console.aws.amazon.com/bedrock/home?region=us-west-2#/providers?model=j2-ultra
Supported Params for the Amazon / AI21 models:
- `maxTokens` (int32): The maximum number of tokens to generate per result. Optional, default is 16. If no `stopSequences` are given, generation stops after producing `maxTokens`.
- `temperature` (float): Modifies the distribution from which tokens are sampled. Optional, default is 0.7. A value of 0 essentially disables sampling and results in greedy decoding.
- `topP` (float): Used for sampling tokens from the corresponding top percentile of probability mass. Optional, default is 1. For instance, a value of 0.9 considers only tokens comprising the top 90% probability mass.
- `stopSequences` (array of strings): Stops decoding if any of the input strings is generated. Optional.
- `frequencyPenalty` (object): Placeholder for frequency penalty object.
- `presencePenalty` (object): Placeholder for presence penalty object.
- `countPenalty` (object): Placeholder for count penalty object.
|
class AmazonAI21Config:
"""
Reference: https://us-west-2.console.aws.amazon.com/bedrock/home?region=us-west-2#/providers?model=j2-ultra
Supported Params for the Amazon / AI21 models:
- `maxTokens` (int32): The maximum number of tokens to generate per result. Optional, default is 16. If no `stopSequences` are given, generation stops after producing `maxTokens`.
- `temperature` (float): Modifies the distribution from which tokens are sampled. Optional, default is 0.7. A value of 0 essentially disables sampling and results in greedy decoding.
- `topP` (float): Used for sampling tokens from the corresponding top percentile of probability mass. Optional, default is 1. For instance, a value of 0.9 considers only tokens comprising the top 90% probability mass.
- `stopSequences` (array of strings): Stops decoding if any of the input strings is generated. Optional.
- `frequencyPenalty` (object): Placeholder for frequency penalty object.
- `presencePenalty` (object): Placeholder for presence penalty object.
- `countPenalty` (object): Placeholder for count penalty object.
"""
maxTokens: Optional[int] = None
temperature: Optional[float] = None
topP: Optional[float] = None
stopSequences: Optional[list] = None
frequencePenalty: Optional[dict] = None
presencePenalty: Optional[dict] = None
countPenalty: Optional[dict] = None
def __init__(
self,
maxTokens: Optional[int] = None,
temperature: Optional[float] = None,
topP: Optional[float] = None,
stopSequences: Optional[list] = None,
frequencePenalty: Optional[dict] = None,
presencePenalty: Optional[dict] = None,
countPenalty: Optional[dict] = None,
) -> None:
locals_ = locals()
for key, value in locals_.items():
if key != "self" and value is not None:
setattr(self.__class__, key, value)
@classmethod
def get_config(cls):
return {
k: v
for k, v in cls.__dict__.items()
if not k.startswith("__")
and not isinstance(
v,
(
types.FunctionType,
types.BuiltinFunctionType,
classmethod,
staticmethod,
),
)
and v is not None
}
|
(maxTokens: Optional[int] = None, temperature: Optional[float] = None, topP: Optional[float] = None, stopSequences: Optional[list] = None, frequencePenalty: Optional[dict] = None, presencePenalty: Optional[dict] = None, countPenalty: Optional[dict] = None) -> None
|
62,832 |
litellm.llms.bedrock
|
__init__
| null |
def __init__(
self,
maxTokens: Optional[int] = None,
temperature: Optional[float] = None,
topP: Optional[float] = None,
stopSequences: Optional[list] = None,
frequencePenalty: Optional[dict] = None,
presencePenalty: Optional[dict] = None,
countPenalty: Optional[dict] = None,
) -> None:
locals_ = locals()
for key, value in locals_.items():
if key != "self" and value is not None:
setattr(self.__class__, key, value)
|
(self, maxTokens: Optional[int] = None, temperature: Optional[float] = None, topP: Optional[float] = None, stopSequences: Optional[list] = None, frequencePenalty: Optional[dict] = None, presencePenalty: Optional[dict] = None, countPenalty: Optional[dict] = None) -> NoneType
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.