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,587
mailchimp_transactional.api.exports_api
info_with_http_info
View export info # noqa: E501 Returns information about an export job. If the export job's state is 'complete', the returned data will include a URL you can use to fetch the results. Every export job produces a zip archive, but the format of the archive is distinct for each job type. The api calls that initiate exports include more details about the output format for that job type. # noqa: E501
def info_with_http_info(self, body, **kwargs): # noqa: E501 """View export info # noqa: E501 Returns information about an export job. If the export job's state is 'complete', the returned data will include a URL you can use to fetch the results. Every export job produces a zip archive, but the format of the archive is distinct for each job type. The api calls that initiate exports include more details about the output format for that job type. # 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( '/exports/info', 'POST', body=body_params, response_type='InlineResponse2003') # noqa: E501
(self, body, **kwargs)
62,588
mailchimp_transactional.api.exports_api
list
List exports # noqa: E501 Returns a list of your exports. # noqa: E501
def list(self, body = {}, **kwargs): # noqa: E501 """List exports # noqa: E501 Returns a list of your exports. # noqa: E501 """ (data) = self.list_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,589
mailchimp_transactional.api.exports_api
list_with_http_info
List exports # noqa: E501 Returns a list of your exports. # noqa: E501
def list_with_http_info(self, body, **kwargs): # noqa: E501 """List exports # noqa: E501 Returns a list of your exports. # 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( '/exports/list', 'POST', body=body_params, response_type='list[InlineResponse2004]') # noqa: E501
(self, body, **kwargs)
62,590
mailchimp_transactional.api.exports_api
rejects
Export denylist # noqa: E501 Begins an export of your rejection denylist. The denylist will be exported to a zip archive containing a single file named rejects.csv that includes the following fields: email, reason, detail, created_at, expires_at, last_event_at, expires_at. # noqa: E501
def rejects(self, body = {}, **kwargs): # noqa: E501 """Export denylist # noqa: E501 Begins an export of your rejection denylist. The denylist will be exported to a zip archive containing a single file named rejects.csv that includes the following fields: email, reason, detail, created_at, expires_at, last_event_at, expires_at. # noqa: E501 """ (data) = self.rejects_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,591
mailchimp_transactional.api.exports_api
rejects_with_http_info
Export denylist # noqa: E501 Begins an export of your rejection denylist. The denylist will be exported to a zip archive containing a single file named rejects.csv that includes the following fields: email, reason, detail, created_at, expires_at, last_event_at, expires_at. # noqa: E501
def rejects_with_http_info(self, body, **kwargs): # noqa: E501 """Export denylist # noqa: E501 Begins an export of your rejection denylist. The denylist will be exported to a zip archive containing a single file named rejects.csv that includes the following fields: email, reason, detail, created_at, expires_at, last_event_at, expires_at. # 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 rejects" % 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( '/exports/rejects', 'POST', body=body_params, response_type='InlineResponse2005') # noqa: E501
(self, body, **kwargs)
62,592
mailchimp_transactional.api.exports_api
whitelist
Export Allowlist # noqa: E501 Begins an export of your rejection allowlist. The allowlist will be exported to a zip archive containing a single file named allowlist.csv that includes the following fields: email, detail, created_at. # noqa: E501
def whitelist(self, body = {}, **kwargs): # noqa: E501 """Export Allowlist # noqa: E501 Begins an export of your rejection allowlist. The allowlist will be exported to a zip archive containing a single file named allowlist.csv that includes the following fields: email, detail, created_at. # noqa: E501 """ (data) = self.whitelist_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,593
mailchimp_transactional.api.exports_api
whitelist_with_http_info
Export Allowlist # noqa: E501 Begins an export of your rejection allowlist. The allowlist will be exported to a zip archive containing a single file named allowlist.csv that includes the following fields: email, detail, created_at. # noqa: E501
def whitelist_with_http_info(self, body, **kwargs): # noqa: E501 """Export Allowlist # noqa: E501 Begins an export of your rejection allowlist. The allowlist will be exported to a zip archive containing a single file named allowlist.csv that includes the following fields: email, detail, created_at. # 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 whitelist" % 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( '/exports/whitelist', 'POST', body=body_params, response_type='InlineResponse2006') # noqa: E501
(self, body, **kwargs)
62,594
mailchimp_transactional.api.inbound_api
InboundApi
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 InboundApi(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_domain(self, body = {}, **kwargs): # noqa: E501 """Add inbound domain # noqa: E501 Add an inbound domain to your account. # noqa: E501 """ (data) = self.add_domain_with_http_info(body, **kwargs) # noqa: E501 return data def add_domain_with_http_info(self, body, **kwargs): # noqa: E501 """Add inbound domain # noqa: E501 Add an inbound 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_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( '/inbound/add-domain', 'POST', body=body_params, response_type='InlineResponse2009') # noqa: E501 def add_route(self, body = {}, **kwargs): # noqa: E501 """Add mailbox route # noqa: E501 Add a new mailbox route to an inbound domain. # noqa: E501 """ (data) = self.add_route_with_http_info(body, **kwargs) # noqa: E501 return data def add_route_with_http_info(self, body, **kwargs): # noqa: E501 """Add mailbox route # noqa: E501 Add a new mailbox route to an inbound 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 add_route" % 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( '/inbound/add-route', 'POST', body=body_params, response_type='InlineResponse20013') # noqa: E501 def check_domain(self, body = {}, **kwargs): # noqa: E501 """Check domain settings # noqa: E501 Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call. # noqa: E501 """ (data) = self.check_domain_with_http_info(body, **kwargs) # noqa: E501 return data def check_domain_with_http_info(self, body, **kwargs): # noqa: E501 """Check domain settings # noqa: E501 Check the MX settings for an inbound domain. The domain must have already been added with the add-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_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( '/inbound/check-domain', 'POST', body=body_params, response_type='InlineResponse20010') # noqa: E501 def delete_domain(self, body = {}, **kwargs): # noqa: E501 """Delete inbound domain # noqa: E501 Delete an inbound domain from the account. All mail will stop routing for this domain immediately. # noqa: E501 """ (data) = self.delete_domain_with_http_info(body, **kwargs) # noqa: E501 return data def delete_domain_with_http_info(self, body, **kwargs): # noqa: E501 """Delete inbound domain # noqa: E501 Delete an inbound domain from the account. All mail will stop routing for this domain immediately. # 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_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( '/inbound/delete-domain', 'POST', body=body_params, response_type='InlineResponse20011') # noqa: E501 def delete_route(self, body = {}, **kwargs): # noqa: E501 """Delete mailbox route # noqa: E501 Delete an existing inbound mailbox route. # noqa: E501 """ (data) = self.delete_route_with_http_info(body, **kwargs) # noqa: E501 return data def delete_route_with_http_info(self, body, **kwargs): # noqa: E501 """Delete mailbox route # noqa: E501 Delete an existing inbound mailbox route. # 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_route" % 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( '/inbound/delete-route', 'POST', body=body_params, response_type='InlineResponse20015') # noqa: E501 def domains(self, body = {}, **kwargs): # noqa: E501 """List inbound domains # noqa: E501 List the domains that have been configured for inbound delivery. # noqa: E501 """ (data) = self.domains_with_http_info(body, **kwargs) # noqa: E501 return data def domains_with_http_info(self, body, **kwargs): # noqa: E501 """List inbound domains # noqa: E501 List the domains that have been configured for inbound delivery. # 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 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( '/inbound/domains', 'POST', body=body_params, response_type='list[InlineResponse2008]') # noqa: E501 def routes(self, body = {}, **kwargs): # noqa: E501 """List mailbox routes # noqa: E501 List the mailbox routes defined for an inbound domain. # noqa: E501 """ (data) = self.routes_with_http_info(body, **kwargs) # noqa: E501 return data def routes_with_http_info(self, body, **kwargs): # noqa: E501 """List mailbox routes # noqa: E501 List the mailbox routes defined for an inbound 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 routes" % 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( '/inbound/routes', 'POST', body=body_params, response_type='list[InlineResponse20012]') # noqa: E501 def send_raw(self, body = {}, **kwargs): # noqa: E501 """Send mime document # noqa: E501 Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP. # noqa: E501 """ (data) = self.send_raw_with_http_info(body, **kwargs) # noqa: E501 return data def send_raw_with_http_info(self, body, **kwargs): # noqa: E501 """Send mime document # noqa: E501 Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP. # 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 send_raw" % 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( '/inbound/send-raw', 'POST', body=body_params, response_type='list[InlineResponse20016]') # noqa: E501 def update_route(self, body = {}, **kwargs): # noqa: E501 """Update mailbox route # noqa: E501 Update the pattern or webhook of an existing inbound mailbox route. If null is provided for any fields, the values will remain unchanged. # noqa: E501 """ (data) = self.update_route_with_http_info(body, **kwargs) # noqa: E501 return data def update_route_with_http_info(self, body, **kwargs): # noqa: E501 """Update mailbox route # noqa: E501 Update the pattern or webhook of an existing inbound mailbox route. 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_route" % 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( '/inbound/update-route', 'POST', body=body_params, response_type='InlineResponse20014') # noqa: E501
(api_key='', api_client=None)
62,596
mailchimp_transactional.api.inbound_api
add_domain
Add inbound domain # noqa: E501 Add an inbound domain to your account. # noqa: E501
def add_domain(self, body = {}, **kwargs): # noqa: E501 """Add inbound domain # noqa: E501 Add an inbound domain to your account. # noqa: E501 """ (data) = self.add_domain_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,597
mailchimp_transactional.api.inbound_api
add_domain_with_http_info
Add inbound domain # noqa: E501 Add an inbound domain to your account. # noqa: E501
def add_domain_with_http_info(self, body, **kwargs): # noqa: E501 """Add inbound domain # noqa: E501 Add an inbound 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_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( '/inbound/add-domain', 'POST', body=body_params, response_type='InlineResponse2009') # noqa: E501
(self, body, **kwargs)
62,598
mailchimp_transactional.api.inbound_api
add_route
Add mailbox route # noqa: E501 Add a new mailbox route to an inbound domain. # noqa: E501
def add_route(self, body = {}, **kwargs): # noqa: E501 """Add mailbox route # noqa: E501 Add a new mailbox route to an inbound domain. # noqa: E501 """ (data) = self.add_route_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,599
mailchimp_transactional.api.inbound_api
add_route_with_http_info
Add mailbox route # noqa: E501 Add a new mailbox route to an inbound domain. # noqa: E501
def add_route_with_http_info(self, body, **kwargs): # noqa: E501 """Add mailbox route # noqa: E501 Add a new mailbox route to an inbound 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 add_route" % 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( '/inbound/add-route', 'POST', body=body_params, response_type='InlineResponse20013') # noqa: E501
(self, body, **kwargs)
62,600
mailchimp_transactional.api.inbound_api
check_domain
Check domain settings # noqa: E501 Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call. # noqa: E501
def check_domain(self, body = {}, **kwargs): # noqa: E501 """Check domain settings # noqa: E501 Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call. # noqa: E501 """ (data) = self.check_domain_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,601
mailchimp_transactional.api.inbound_api
check_domain_with_http_info
Check domain settings # noqa: E501 Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call. # noqa: E501
def check_domain_with_http_info(self, body, **kwargs): # noqa: E501 """Check domain settings # noqa: E501 Check the MX settings for an inbound domain. The domain must have already been added with the add-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_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( '/inbound/check-domain', 'POST', body=body_params, response_type='InlineResponse20010') # noqa: E501
(self, body, **kwargs)
62,602
mailchimp_transactional.api.inbound_api
delete_domain
Delete inbound domain # noqa: E501 Delete an inbound domain from the account. All mail will stop routing for this domain immediately. # noqa: E501
def delete_domain(self, body = {}, **kwargs): # noqa: E501 """Delete inbound domain # noqa: E501 Delete an inbound domain from the account. All mail will stop routing for this domain immediately. # noqa: E501 """ (data) = self.delete_domain_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,603
mailchimp_transactional.api.inbound_api
delete_domain_with_http_info
Delete inbound domain # noqa: E501 Delete an inbound domain from the account. All mail will stop routing for this domain immediately. # noqa: E501
def delete_domain_with_http_info(self, body, **kwargs): # noqa: E501 """Delete inbound domain # noqa: E501 Delete an inbound domain from the account. All mail will stop routing for this domain immediately. # 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_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( '/inbound/delete-domain', 'POST', body=body_params, response_type='InlineResponse20011') # noqa: E501
(self, body, **kwargs)
62,604
mailchimp_transactional.api.inbound_api
delete_route
Delete mailbox route # noqa: E501 Delete an existing inbound mailbox route. # noqa: E501
def delete_route(self, body = {}, **kwargs): # noqa: E501 """Delete mailbox route # noqa: E501 Delete an existing inbound mailbox route. # noqa: E501 """ (data) = self.delete_route_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,605
mailchimp_transactional.api.inbound_api
delete_route_with_http_info
Delete mailbox route # noqa: E501 Delete an existing inbound mailbox route. # noqa: E501
def delete_route_with_http_info(self, body, **kwargs): # noqa: E501 """Delete mailbox route # noqa: E501 Delete an existing inbound mailbox route. # 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_route" % 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( '/inbound/delete-route', 'POST', body=body_params, response_type='InlineResponse20015') # noqa: E501
(self, body, **kwargs)
62,606
mailchimp_transactional.api.inbound_api
domains
List inbound domains # noqa: E501 List the domains that have been configured for inbound delivery. # noqa: E501
def domains(self, body = {}, **kwargs): # noqa: E501 """List inbound domains # noqa: E501 List the domains that have been configured for inbound delivery. # noqa: E501 """ (data) = self.domains_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,607
mailchimp_transactional.api.inbound_api
domains_with_http_info
List inbound domains # noqa: E501 List the domains that have been configured for inbound delivery. # noqa: E501
def domains_with_http_info(self, body, **kwargs): # noqa: E501 """List inbound domains # noqa: E501 List the domains that have been configured for inbound delivery. # 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 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( '/inbound/domains', 'POST', body=body_params, response_type='list[InlineResponse2008]') # noqa: E501
(self, body, **kwargs)
62,608
mailchimp_transactional.api.inbound_api
routes
List mailbox routes # noqa: E501 List the mailbox routes defined for an inbound domain. # noqa: E501
def routes(self, body = {}, **kwargs): # noqa: E501 """List mailbox routes # noqa: E501 List the mailbox routes defined for an inbound domain. # noqa: E501 """ (data) = self.routes_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,609
mailchimp_transactional.api.inbound_api
routes_with_http_info
List mailbox routes # noqa: E501 List the mailbox routes defined for an inbound domain. # noqa: E501
def routes_with_http_info(self, body, **kwargs): # noqa: E501 """List mailbox routes # noqa: E501 List the mailbox routes defined for an inbound 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 routes" % 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( '/inbound/routes', 'POST', body=body_params, response_type='list[InlineResponse20012]') # noqa: E501
(self, body, **kwargs)
62,610
mailchimp_transactional.api.inbound_api
send_raw
Send mime document # noqa: E501 Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP. # noqa: E501
def send_raw(self, body = {}, **kwargs): # noqa: E501 """Send mime document # noqa: E501 Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP. # noqa: E501 """ (data) = self.send_raw_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,611
mailchimp_transactional.api.inbound_api
send_raw_with_http_info
Send mime document # noqa: E501 Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP. # noqa: E501
def send_raw_with_http_info(self, body, **kwargs): # noqa: E501 """Send mime document # noqa: E501 Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP. # 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 send_raw" % 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( '/inbound/send-raw', 'POST', body=body_params, response_type='list[InlineResponse20016]') # noqa: E501
(self, body, **kwargs)
62,612
mailchimp_transactional.api.inbound_api
update_route
Update mailbox route # noqa: E501 Update the pattern or webhook of an existing inbound mailbox route. If null is provided for any fields, the values will remain unchanged. # noqa: E501
def update_route(self, body = {}, **kwargs): # noqa: E501 """Update mailbox route # noqa: E501 Update the pattern or webhook of an existing inbound mailbox route. If null is provided for any fields, the values will remain unchanged. # noqa: E501 """ (data) = self.update_route_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,613
mailchimp_transactional.api.inbound_api
update_route_with_http_info
Update mailbox route # noqa: E501 Update the pattern or webhook of an existing inbound mailbox route. If null is provided for any fields, the values will remain unchanged. # noqa: E501
def update_route_with_http_info(self, body, **kwargs): # noqa: E501 """Update mailbox route # noqa: E501 Update the pattern or webhook of an existing inbound mailbox route. 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_route" % 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( '/inbound/update-route', 'POST', body=body_params, response_type='InlineResponse20014') # noqa: E501
(self, body, **kwargs)
62,614
mailchimp_transactional.api.ips_api
IpsApi
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 IpsApi(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 cancel_warmup(self, body = {}, **kwargs): # noqa: E501 """Cancel ip warmup # noqa: E501 Cancels the warmup process for a dedicated IP. # noqa: E501 """ (data) = self.cancel_warmup_with_http_info(body, **kwargs) # noqa: E501 return data def cancel_warmup_with_http_info(self, body, **kwargs): # noqa: E501 """Cancel ip warmup # noqa: E501 Cancels the warmup process for a dedicated IP. # 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 cancel_warmup" % 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( '/ips/cancel-warmup', 'POST', body=body_params, response_type='InlineResponse20020') # noqa: E501 def check_custom_dns(self, body = {}, **kwargs): # noqa: E501 """Test custom dns # noqa: E501 Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP. # noqa: E501 """ (data) = self.check_custom_dns_with_http_info(body, **kwargs) # noqa: E501 return data def check_custom_dns_with_http_info(self, body, **kwargs): # noqa: E501 """Test custom dns # noqa: E501 Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP. # 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_custom_dns" % 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( '/ips/check-custom-dns', 'POST', body=body_params, response_type='InlineResponse20026') # noqa: E501 def create_pool(self, body = {}, **kwargs): # noqa: E501 """Add ip pool # noqa: E501 Creates a pool and returns it. If a pool already exists with this name, no action will be performed. # noqa: E501 """ (data) = self.create_pool_with_http_info(body, **kwargs) # noqa: E501 return data def create_pool_with_http_info(self, body, **kwargs): # noqa: E501 """Add ip pool # noqa: E501 Creates a pool and returns it. If a pool already exists with this name, no action will be performed. # 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 create_pool" % 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( '/ips/create-pool', 'POST', body=body_params, response_type='InlineResponse20024') # noqa: E501 def delete(self, body = {}, **kwargs): # noqa: E501 """Delete ip address # noqa: E501 Deletes a dedicated IP. This is permanent and cannot be undone. # 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 ip address # noqa: E501 Deletes a dedicated IP. This is permanent and cannot be undone. # 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( '/ips/delete', 'POST', body=body_params, response_type='InlineResponse20022') # noqa: E501 def delete_pool(self, body = {}, **kwargs): # noqa: E501 """Delete ip pool # noqa: E501 Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool. # noqa: E501 """ (data) = self.delete_pool_with_http_info(body, **kwargs) # noqa: E501 return data def delete_pool_with_http_info(self, body, **kwargs): # noqa: E501 """Delete ip pool # noqa: E501 Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool. # 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_pool" % 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( '/ips/delete-pool', 'POST', body=body_params, response_type='InlineResponse20025') # noqa: E501 def info(self, body = {}, **kwargs): # noqa: E501 """Get ip info # noqa: E501 Retrieves information about a single dedicated IP. # 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 ip info # noqa: E501 Retrieves information about a single dedicated IP. # 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( '/ips/info', 'POST', body=body_params, response_type='InlineResponse20018') # noqa: E501 def list(self, body = {}, **kwargs): # noqa: E501 """List ip addresses # noqa: E501 Lists your dedicated IPs. # 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 ip addresses # noqa: E501 Lists your dedicated IPs. # 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( '/ips/list', 'POST', body=body_params, response_type='list[InlineResponse20017]') # noqa: E501 def list_pools(self, body = {}, **kwargs): # noqa: E501 """List ip pools # noqa: E501 Lists your dedicated IP pools. # noqa: E501 """ (data) = self.list_pools_with_http_info(body, **kwargs) # noqa: E501 return data def list_pools_with_http_info(self, body, **kwargs): # noqa: E501 """List ip pools # noqa: E501 Lists your dedicated IP pools. # 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_pools" % 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( '/ips/list-pools', 'POST', body=body_params, response_type='list[InlineResponse20023]') # noqa: E501 def pool_info(self, body = {}, **kwargs): # noqa: E501 """Get ip pool info # noqa: E501 Describes a single dedicated IP pool. # noqa: E501 """ (data) = self.pool_info_with_http_info(body, **kwargs) # noqa: E501 return data def pool_info_with_http_info(self, body, **kwargs): # noqa: E501 """Get ip pool info # noqa: E501 Describes a single dedicated IP pool. # 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 pool_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( '/ips/pool-info', 'POST', body=body_params, response_type='InlineResponse20024') # noqa: E501 def provision(self, body = {}, **kwargs): # noqa: E501 """Request additional ip # noqa: E501 Requests an additional dedicated IP for your account. Accounts may have one outstanding request at any time, and provisioning requests are processed within 24 hours. # noqa: E501 """ (data) = self.provision_with_http_info(body, **kwargs) # noqa: E501 return data def provision_with_http_info(self, body, **kwargs): # noqa: E501 """Request additional ip # noqa: E501 Requests an additional dedicated IP for your account. Accounts may have one outstanding request at any time, and provisioning requests are processed within 24 hours. # 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 provision" % 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( '/ips/provision', 'POST', body=body_params, response_type='InlineResponse20019') # noqa: E501 def set_custom_dns(self, body = {}, **kwargs): # noqa: E501 """Set custom dns # noqa: E501 Configures the custom DNS name for a dedicated IP. # noqa: E501 """ (data) = self.set_custom_dns_with_http_info(body, **kwargs) # noqa: E501 return data def set_custom_dns_with_http_info(self, body, **kwargs): # noqa: E501 """Set custom dns # noqa: E501 Configures the custom DNS name for a dedicated IP. # 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 set_custom_dns" % 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( '/ips/set-custom-dns', 'POST', body=body_params, response_type='InlineResponse20027') # noqa: E501 def set_pool(self, body = {}, **kwargs): # noqa: E501 """Move ip to different pool # noqa: E501 Moves a dedicated IP to a different pool. # noqa: E501 """ (data) = self.set_pool_with_http_info(body, **kwargs) # noqa: E501 return data def set_pool_with_http_info(self, body, **kwargs): # noqa: E501 """Move ip to different pool # noqa: E501 Moves a dedicated IP to a different pool. # 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 set_pool" % 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( '/ips/set-pool', 'POST', body=body_params, response_type='InlineResponse20021') # noqa: E501 def start_warmup(self, body = {}, **kwargs): # noqa: E501 """Start ip warmup # noqa: E501 Begins the warmup process for a dedicated IP. During the warmup process, the Transactional API will gradually increase the percentage of your mail that is sent over the warming-up IP, over a period of roughly 30 days. The rest of your mail will be sent over shared IPs or other dedicated IPs in the same pool. # noqa: E501 """ (data) = self.start_warmup_with_http_info(body, **kwargs) # noqa: E501 return data def start_warmup_with_http_info(self, body, **kwargs): # noqa: E501 """Start ip warmup # noqa: E501 Begins the warmup process for a dedicated IP. During the warmup process, the Transactional API will gradually increase the percentage of your mail that is sent over the warming-up IP, over a period of roughly 30 days. The rest of your mail will be sent over shared IPs or other dedicated IPs in the same pool. # 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 start_warmup" % 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( '/ips/start-warmup', 'POST', body=body_params, response_type='InlineResponse20020') # noqa: E501
(api_key='', api_client=None)
62,616
mailchimp_transactional.api.ips_api
cancel_warmup
Cancel ip warmup # noqa: E501 Cancels the warmup process for a dedicated IP. # noqa: E501
def cancel_warmup(self, body = {}, **kwargs): # noqa: E501 """Cancel ip warmup # noqa: E501 Cancels the warmup process for a dedicated IP. # noqa: E501 """ (data) = self.cancel_warmup_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,617
mailchimp_transactional.api.ips_api
cancel_warmup_with_http_info
Cancel ip warmup # noqa: E501 Cancels the warmup process for a dedicated IP. # noqa: E501
def cancel_warmup_with_http_info(self, body, **kwargs): # noqa: E501 """Cancel ip warmup # noqa: E501 Cancels the warmup process for a dedicated IP. # 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 cancel_warmup" % 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( '/ips/cancel-warmup', 'POST', body=body_params, response_type='InlineResponse20020') # noqa: E501
(self, body, **kwargs)
62,618
mailchimp_transactional.api.ips_api
check_custom_dns
Test custom dns # noqa: E501 Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP. # noqa: E501
def check_custom_dns(self, body = {}, **kwargs): # noqa: E501 """Test custom dns # noqa: E501 Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP. # noqa: E501 """ (data) = self.check_custom_dns_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,619
mailchimp_transactional.api.ips_api
check_custom_dns_with_http_info
Test custom dns # noqa: E501 Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP. # noqa: E501
def check_custom_dns_with_http_info(self, body, **kwargs): # noqa: E501 """Test custom dns # noqa: E501 Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP. # 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_custom_dns" % 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( '/ips/check-custom-dns', 'POST', body=body_params, response_type='InlineResponse20026') # noqa: E501
(self, body, **kwargs)
62,620
mailchimp_transactional.api.ips_api
create_pool
Add ip pool # noqa: E501 Creates a pool and returns it. If a pool already exists with this name, no action will be performed. # noqa: E501
def create_pool(self, body = {}, **kwargs): # noqa: E501 """Add ip pool # noqa: E501 Creates a pool and returns it. If a pool already exists with this name, no action will be performed. # noqa: E501 """ (data) = self.create_pool_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,621
mailchimp_transactional.api.ips_api
create_pool_with_http_info
Add ip pool # noqa: E501 Creates a pool and returns it. If a pool already exists with this name, no action will be performed. # noqa: E501
def create_pool_with_http_info(self, body, **kwargs): # noqa: E501 """Add ip pool # noqa: E501 Creates a pool and returns it. If a pool already exists with this name, no action will be performed. # 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 create_pool" % 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( '/ips/create-pool', 'POST', body=body_params, response_type='InlineResponse20024') # noqa: E501
(self, body, **kwargs)
62,622
mailchimp_transactional.api.ips_api
delete
Delete ip address # noqa: E501 Deletes a dedicated IP. This is permanent and cannot be undone. # noqa: E501
def delete(self, body = {}, **kwargs): # noqa: E501 """Delete ip address # noqa: E501 Deletes a dedicated IP. This is permanent and cannot be undone. # noqa: E501 """ (data) = self.delete_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,623
mailchimp_transactional.api.ips_api
delete_pool
Delete ip pool # noqa: E501 Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool. # noqa: E501
def delete_pool(self, body = {}, **kwargs): # noqa: E501 """Delete ip pool # noqa: E501 Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool. # noqa: E501 """ (data) = self.delete_pool_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,624
mailchimp_transactional.api.ips_api
delete_pool_with_http_info
Delete ip pool # noqa: E501 Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool. # noqa: E501
def delete_pool_with_http_info(self, body, **kwargs): # noqa: E501 """Delete ip pool # noqa: E501 Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool. # 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_pool" % 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( '/ips/delete-pool', 'POST', body=body_params, response_type='InlineResponse20025') # noqa: E501
(self, body, **kwargs)
62,625
mailchimp_transactional.api.ips_api
delete_with_http_info
Delete ip address # noqa: E501 Deletes a dedicated IP. This is permanent and cannot be undone. # noqa: E501
def delete_with_http_info(self, body, **kwargs): # noqa: E501 """Delete ip address # noqa: E501 Deletes a dedicated IP. This is permanent and cannot be undone. # 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( '/ips/delete', 'POST', body=body_params, response_type='InlineResponse20022') # noqa: E501
(self, body, **kwargs)
62,626
mailchimp_transactional.api.ips_api
info
Get ip info # noqa: E501 Retrieves information about a single dedicated IP. # noqa: E501
def info(self, body = {}, **kwargs): # noqa: E501 """Get ip info # noqa: E501 Retrieves information about a single dedicated IP. # noqa: E501 """ (data) = self.info_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,627
mailchimp_transactional.api.ips_api
info_with_http_info
Get ip info # noqa: E501 Retrieves information about a single dedicated IP. # noqa: E501
def info_with_http_info(self, body, **kwargs): # noqa: E501 """Get ip info # noqa: E501 Retrieves information about a single dedicated IP. # 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( '/ips/info', 'POST', body=body_params, response_type='InlineResponse20018') # noqa: E501
(self, body, **kwargs)
62,628
mailchimp_transactional.api.ips_api
list
List ip addresses # noqa: E501 Lists your dedicated IPs. # noqa: E501
def list(self, body = {}, **kwargs): # noqa: E501 """List ip addresses # noqa: E501 Lists your dedicated IPs. # noqa: E501 """ (data) = self.list_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,629
mailchimp_transactional.api.ips_api
list_pools
List ip pools # noqa: E501 Lists your dedicated IP pools. # noqa: E501
def list_pools(self, body = {}, **kwargs): # noqa: E501 """List ip pools # noqa: E501 Lists your dedicated IP pools. # noqa: E501 """ (data) = self.list_pools_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,630
mailchimp_transactional.api.ips_api
list_pools_with_http_info
List ip pools # noqa: E501 Lists your dedicated IP pools. # noqa: E501
def list_pools_with_http_info(self, body, **kwargs): # noqa: E501 """List ip pools # noqa: E501 Lists your dedicated IP pools. # 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_pools" % 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( '/ips/list-pools', 'POST', body=body_params, response_type='list[InlineResponse20023]') # noqa: E501
(self, body, **kwargs)
62,631
mailchimp_transactional.api.ips_api
list_with_http_info
List ip addresses # noqa: E501 Lists your dedicated IPs. # noqa: E501
def list_with_http_info(self, body, **kwargs): # noqa: E501 """List ip addresses # noqa: E501 Lists your dedicated IPs. # 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( '/ips/list', 'POST', body=body_params, response_type='list[InlineResponse20017]') # noqa: E501
(self, body, **kwargs)
62,632
mailchimp_transactional.api.ips_api
pool_info
Get ip pool info # noqa: E501 Describes a single dedicated IP pool. # noqa: E501
def pool_info(self, body = {}, **kwargs): # noqa: E501 """Get ip pool info # noqa: E501 Describes a single dedicated IP pool. # noqa: E501 """ (data) = self.pool_info_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,633
mailchimp_transactional.api.ips_api
pool_info_with_http_info
Get ip pool info # noqa: E501 Describes a single dedicated IP pool. # noqa: E501
def pool_info_with_http_info(self, body, **kwargs): # noqa: E501 """Get ip pool info # noqa: E501 Describes a single dedicated IP pool. # 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 pool_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( '/ips/pool-info', 'POST', body=body_params, response_type='InlineResponse20024') # noqa: E501
(self, body, **kwargs)
62,634
mailchimp_transactional.api.ips_api
provision
Request additional ip # noqa: E501 Requests an additional dedicated IP for your account. Accounts may have one outstanding request at any time, and provisioning requests are processed within 24 hours. # noqa: E501
def provision(self, body = {}, **kwargs): # noqa: E501 """Request additional ip # noqa: E501 Requests an additional dedicated IP for your account. Accounts may have one outstanding request at any time, and provisioning requests are processed within 24 hours. # noqa: E501 """ (data) = self.provision_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,635
mailchimp_transactional.api.ips_api
provision_with_http_info
Request additional ip # noqa: E501 Requests an additional dedicated IP for your account. Accounts may have one outstanding request at any time, and provisioning requests are processed within 24 hours. # noqa: E501
def provision_with_http_info(self, body, **kwargs): # noqa: E501 """Request additional ip # noqa: E501 Requests an additional dedicated IP for your account. Accounts may have one outstanding request at any time, and provisioning requests are processed within 24 hours. # 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 provision" % 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( '/ips/provision', 'POST', body=body_params, response_type='InlineResponse20019') # noqa: E501
(self, body, **kwargs)
62,636
mailchimp_transactional.api.ips_api
set_custom_dns
Set custom dns # noqa: E501 Configures the custom DNS name for a dedicated IP. # noqa: E501
def set_custom_dns(self, body = {}, **kwargs): # noqa: E501 """Set custom dns # noqa: E501 Configures the custom DNS name for a dedicated IP. # noqa: E501 """ (data) = self.set_custom_dns_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,637
mailchimp_transactional.api.ips_api
set_custom_dns_with_http_info
Set custom dns # noqa: E501 Configures the custom DNS name for a dedicated IP. # noqa: E501
def set_custom_dns_with_http_info(self, body, **kwargs): # noqa: E501 """Set custom dns # noqa: E501 Configures the custom DNS name for a dedicated IP. # 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 set_custom_dns" % 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( '/ips/set-custom-dns', 'POST', body=body_params, response_type='InlineResponse20027') # noqa: E501
(self, body, **kwargs)
62,638
mailchimp_transactional.api.ips_api
set_pool
Move ip to different pool # noqa: E501 Moves a dedicated IP to a different pool. # noqa: E501
def set_pool(self, body = {}, **kwargs): # noqa: E501 """Move ip to different pool # noqa: E501 Moves a dedicated IP to a different pool. # noqa: E501 """ (data) = self.set_pool_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,639
mailchimp_transactional.api.ips_api
set_pool_with_http_info
Move ip to different pool # noqa: E501 Moves a dedicated IP to a different pool. # noqa: E501
def set_pool_with_http_info(self, body, **kwargs): # noqa: E501 """Move ip to different pool # noqa: E501 Moves a dedicated IP to a different pool. # 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 set_pool" % 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( '/ips/set-pool', 'POST', body=body_params, response_type='InlineResponse20021') # noqa: E501
(self, body, **kwargs)
62,640
mailchimp_transactional.api.ips_api
start_warmup
Start ip warmup # noqa: E501 Begins the warmup process for a dedicated IP. During the warmup process, the Transactional API will gradually increase the percentage of your mail that is sent over the warming-up IP, over a period of roughly 30 days. The rest of your mail will be sent over shared IPs or other dedicated IPs in the same pool. # noqa: E501
def start_warmup(self, body = {}, **kwargs): # noqa: E501 """Start ip warmup # noqa: E501 Begins the warmup process for a dedicated IP. During the warmup process, the Transactional API will gradually increase the percentage of your mail that is sent over the warming-up IP, over a period of roughly 30 days. The rest of your mail will be sent over shared IPs or other dedicated IPs in the same pool. # noqa: E501 """ (data) = self.start_warmup_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,641
mailchimp_transactional.api.ips_api
start_warmup_with_http_info
Start ip warmup # noqa: E501 Begins the warmup process for a dedicated IP. During the warmup process, the Transactional API will gradually increase the percentage of your mail that is sent over the warming-up IP, over a period of roughly 30 days. The rest of your mail will be sent over shared IPs or other dedicated IPs in the same pool. # noqa: E501
def start_warmup_with_http_info(self, body, **kwargs): # noqa: E501 """Start ip warmup # noqa: E501 Begins the warmup process for a dedicated IP. During the warmup process, the Transactional API will gradually increase the percentage of your mail that is sent over the warming-up IP, over a period of roughly 30 days. The rest of your mail will be sent over shared IPs or other dedicated IPs in the same pool. # 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 start_warmup" % 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( '/ips/start-warmup', 'POST', body=body_params, response_type='InlineResponse20020') # noqa: E501
(self, body, **kwargs)
62,642
mailchimp_transactional.api.messages_api
MessagesApi
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 MessagesApi(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 cancel_scheduled(self, body = {}, **kwargs): # noqa: E501 """Cancel scheduled email # noqa: E501 Cancels a scheduled email. # noqa: E501 """ (data) = self.cancel_scheduled_with_http_info(body, **kwargs) # noqa: E501 return data def cancel_scheduled_with_http_info(self, body, **kwargs): # noqa: E501 """Cancel scheduled email # noqa: E501 Cancels a scheduled email. # 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 cancel_scheduled" % 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( '/messages/cancel-scheduled', 'POST', body=body_params, response_type='list[InlineResponse20035]') # noqa: E501 def content(self, body = {}, **kwargs): # noqa: E501 """Get message content # noqa: E501 Get the full content of a recently sent message. # noqa: E501 """ (data) = self.content_with_http_info(body, **kwargs) # noqa: E501 return data def content_with_http_info(self, body, **kwargs): # noqa: E501 """Get message content # noqa: E501 Get the full content of a recently sent message. # 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 content" % 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( '/messages/content', 'POST', body=body_params, response_type='InlineResponse20033') # noqa: E501 def info(self, body = {}, **kwargs): # noqa: E501 """Get message info # noqa: E501 Get the information for a single recently sent message. # 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 message info # noqa: E501 Get the information for a single recently sent message. # 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( '/messages/info', 'POST', body=body_params, response_type='InlineResponse20032') # noqa: E501 def list_scheduled(self, body = {}, **kwargs): # noqa: E501 """List scheduled emails # noqa: E501 Queries your scheduled emails. # noqa: E501 """ (data) = self.list_scheduled_with_http_info(body, **kwargs) # noqa: E501 return data def list_scheduled_with_http_info(self, body, **kwargs): # noqa: E501 """List scheduled emails # noqa: E501 Queries your scheduled emails. # 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_scheduled" % 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( '/messages/list-scheduled', 'POST', body=body_params, response_type='list[InlineResponse20035]') # noqa: E501 def parse(self, body = {}, **kwargs): # noqa: E501 """Parse mime document # noqa: E501 Parse the full MIME document for an email message, returning the content of the message broken into its constituent pieces. # noqa: E501 """ (data) = self.parse_with_http_info(body, **kwargs) # noqa: E501 return data def parse_with_http_info(self, body, **kwargs): # noqa: E501 """Parse mime document # noqa: E501 Parse the full MIME document for an email message, returning the content of the message broken into its constituent pieces. # 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 parse" % 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( '/messages/parse', 'POST', body=body_params, response_type='InlineResponse20034') # noqa: E501 def reschedule(self, body = {}, **kwargs): # noqa: E501 """Reschedule email # noqa: E501 Reschedules a scheduled email. # noqa: E501 """ (data) = self.reschedule_with_http_info(body, **kwargs) # noqa: E501 return data def reschedule_with_http_info(self, body, **kwargs): # noqa: E501 """Reschedule email # noqa: E501 Reschedules a scheduled email. # 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 reschedule" % 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( '/messages/reschedule', 'POST', body=body_params, response_type='list[InlineResponse20035]') # noqa: E501 def search(self, body = {}, **kwargs): # noqa: E501 """Search messages by date # noqa: E501 Search recently sent messages and optionally narrow by date range, tags, senders, and API keys. If no date range is specified, results within the last 7 days are returned. This method may be called up to 20 times per minute. If you need the data more often, you can use /messages/info.json to get the information for a single message, or webhooks to push activity to your own application for querying. # 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 messages by date # noqa: E501 Search recently sent messages and optionally narrow by date range, tags, senders, and API keys. If no date range is specified, results within the last 7 days are returned. This method may be called up to 20 times per minute. If you need the data more often, you can use /messages/info.json to get the information for a single message, or webhooks to push activity to your own application for querying. # 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( '/messages/search', 'POST', body=body_params, response_type='list[InlineResponse20030]') # noqa: E501 def search_time_series(self, body = {}, **kwargs): # noqa: E501 """Search messages by hour # noqa: E501 Search the content of recently sent messages and return the aggregated hourly stats for matching messages. # noqa: E501 """ (data) = self.search_time_series_with_http_info(body, **kwargs) # noqa: E501 return data def search_time_series_with_http_info(self, body, **kwargs): # noqa: E501 """Search messages by hour # noqa: E501 Search the content of recently sent messages and return the aggregated hourly stats for matching messages. # 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_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( '/messages/search-time-series', 'POST', body=body_params, response_type='list[InlineResponse20031]') # noqa: E501 def send(self, body = {}, **kwargs): # noqa: E501 """Send new message # noqa: E501 Send a new transactional message through the Transactional API. # noqa: E501 """ (data) = self.send_with_http_info(body, **kwargs) # noqa: E501 return data def send_with_http_info(self, body, **kwargs): # noqa: E501 """Send new message # noqa: E501 Send a new transactional message through the Transactional API. # 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 send" % 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( '/messages/send', 'POST', body=body_params, response_type='list[InlineResponse20028]') # noqa: E501 def send_raw(self, body = {}, **kwargs): # noqa: E501 """Send mime document # noqa: E501 Take a raw MIME document for a message, and send it exactly as if it were sent through the Transactional API's SMTP servers. # noqa: E501 """ (data) = self.send_raw_with_http_info(body, **kwargs) # noqa: E501 return data def send_raw_with_http_info(self, body, **kwargs): # noqa: E501 """Send mime document # noqa: E501 Take a raw MIME document for a message, and send it exactly as if it were sent through the Transactional API's SMTP servers. # 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 send_raw" % 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( '/messages/send-raw', 'POST', body=body_params, response_type='object') # noqa: E501 def send_template(self, body = {}, **kwargs): # noqa: E501 """Send using message template # noqa: E501 Send a new transactional message through the Transactional API using a template. # noqa: E501 """ (data) = self.send_template_with_http_info(body, **kwargs) # noqa: E501 return data def send_template_with_http_info(self, body, **kwargs): # noqa: E501 """Send using message template # noqa: E501 Send a new transactional message through the Transactional API using 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 send_template" % 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( '/messages/send-template', 'POST', body=body_params, response_type='list[InlineResponse20029]') # noqa: E501
(api_key='', api_client=None)
62,644
mailchimp_transactional.api.messages_api
cancel_scheduled
Cancel scheduled email # noqa: E501 Cancels a scheduled email. # noqa: E501
def cancel_scheduled(self, body = {}, **kwargs): # noqa: E501 """Cancel scheduled email # noqa: E501 Cancels a scheduled email. # noqa: E501 """ (data) = self.cancel_scheduled_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,645
mailchimp_transactional.api.messages_api
cancel_scheduled_with_http_info
Cancel scheduled email # noqa: E501 Cancels a scheduled email. # noqa: E501
def cancel_scheduled_with_http_info(self, body, **kwargs): # noqa: E501 """Cancel scheduled email # noqa: E501 Cancels a scheduled email. # 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 cancel_scheduled" % 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( '/messages/cancel-scheduled', 'POST', body=body_params, response_type='list[InlineResponse20035]') # noqa: E501
(self, body, **kwargs)
62,646
mailchimp_transactional.api.messages_api
content
Get message content # noqa: E501 Get the full content of a recently sent message. # noqa: E501
def content(self, body = {}, **kwargs): # noqa: E501 """Get message content # noqa: E501 Get the full content of a recently sent message. # noqa: E501 """ (data) = self.content_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,647
mailchimp_transactional.api.messages_api
content_with_http_info
Get message content # noqa: E501 Get the full content of a recently sent message. # noqa: E501
def content_with_http_info(self, body, **kwargs): # noqa: E501 """Get message content # noqa: E501 Get the full content of a recently sent message. # 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 content" % 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( '/messages/content', 'POST', body=body_params, response_type='InlineResponse20033') # noqa: E501
(self, body, **kwargs)
62,648
mailchimp_transactional.api.messages_api
info
Get message info # noqa: E501 Get the information for a single recently sent message. # noqa: E501
def info(self, body = {}, **kwargs): # noqa: E501 """Get message info # noqa: E501 Get the information for a single recently sent message. # noqa: E501 """ (data) = self.info_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,649
mailchimp_transactional.api.messages_api
info_with_http_info
Get message info # noqa: E501 Get the information for a single recently sent message. # noqa: E501
def info_with_http_info(self, body, **kwargs): # noqa: E501 """Get message info # noqa: E501 Get the information for a single recently sent message. # 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( '/messages/info', 'POST', body=body_params, response_type='InlineResponse20032') # noqa: E501
(self, body, **kwargs)
62,650
mailchimp_transactional.api.messages_api
list_scheduled
List scheduled emails # noqa: E501 Queries your scheduled emails. # noqa: E501
def list_scheduled(self, body = {}, **kwargs): # noqa: E501 """List scheduled emails # noqa: E501 Queries your scheduled emails. # noqa: E501 """ (data) = self.list_scheduled_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,651
mailchimp_transactional.api.messages_api
list_scheduled_with_http_info
List scheduled emails # noqa: E501 Queries your scheduled emails. # noqa: E501
def list_scheduled_with_http_info(self, body, **kwargs): # noqa: E501 """List scheduled emails # noqa: E501 Queries your scheduled emails. # 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_scheduled" % 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( '/messages/list-scheduled', 'POST', body=body_params, response_type='list[InlineResponse20035]') # noqa: E501
(self, body, **kwargs)
62,652
mailchimp_transactional.api.messages_api
parse
Parse mime document # noqa: E501 Parse the full MIME document for an email message, returning the content of the message broken into its constituent pieces. # noqa: E501
def parse(self, body = {}, **kwargs): # noqa: E501 """Parse mime document # noqa: E501 Parse the full MIME document for an email message, returning the content of the message broken into its constituent pieces. # noqa: E501 """ (data) = self.parse_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,653
mailchimp_transactional.api.messages_api
parse_with_http_info
Parse mime document # noqa: E501 Parse the full MIME document for an email message, returning the content of the message broken into its constituent pieces. # noqa: E501
def parse_with_http_info(self, body, **kwargs): # noqa: E501 """Parse mime document # noqa: E501 Parse the full MIME document for an email message, returning the content of the message broken into its constituent pieces. # 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 parse" % 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( '/messages/parse', 'POST', body=body_params, response_type='InlineResponse20034') # noqa: E501
(self, body, **kwargs)
62,654
mailchimp_transactional.api.messages_api
reschedule
Reschedule email # noqa: E501 Reschedules a scheduled email. # noqa: E501
def reschedule(self, body = {}, **kwargs): # noqa: E501 """Reschedule email # noqa: E501 Reschedules a scheduled email. # noqa: E501 """ (data) = self.reschedule_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,655
mailchimp_transactional.api.messages_api
reschedule_with_http_info
Reschedule email # noqa: E501 Reschedules a scheduled email. # noqa: E501
def reschedule_with_http_info(self, body, **kwargs): # noqa: E501 """Reschedule email # noqa: E501 Reschedules a scheduled email. # 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 reschedule" % 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( '/messages/reschedule', 'POST', body=body_params, response_type='list[InlineResponse20035]') # noqa: E501
(self, body, **kwargs)
62,656
mailchimp_transactional.api.messages_api
search
Search messages by date # noqa: E501 Search recently sent messages and optionally narrow by date range, tags, senders, and API keys. If no date range is specified, results within the last 7 days are returned. This method may be called up to 20 times per minute. If you need the data more often, you can use /messages/info.json to get the information for a single message, or webhooks to push activity to your own application for querying. # noqa: E501
def search(self, body = {}, **kwargs): # noqa: E501 """Search messages by date # noqa: E501 Search recently sent messages and optionally narrow by date range, tags, senders, and API keys. If no date range is specified, results within the last 7 days are returned. This method may be called up to 20 times per minute. If you need the data more often, you can use /messages/info.json to get the information for a single message, or webhooks to push activity to your own application for querying. # noqa: E501 """ (data) = self.search_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,657
mailchimp_transactional.api.messages_api
search_time_series
Search messages by hour # noqa: E501 Search the content of recently sent messages and return the aggregated hourly stats for matching messages. # noqa: E501
def search_time_series(self, body = {}, **kwargs): # noqa: E501 """Search messages by hour # noqa: E501 Search the content of recently sent messages and return the aggregated hourly stats for matching messages. # noqa: E501 """ (data) = self.search_time_series_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,658
mailchimp_transactional.api.messages_api
search_time_series_with_http_info
Search messages by hour # noqa: E501 Search the content of recently sent messages and return the aggregated hourly stats for matching messages. # noqa: E501
def search_time_series_with_http_info(self, body, **kwargs): # noqa: E501 """Search messages by hour # noqa: E501 Search the content of recently sent messages and return the aggregated hourly stats for matching messages. # 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_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( '/messages/search-time-series', 'POST', body=body_params, response_type='list[InlineResponse20031]') # noqa: E501
(self, body, **kwargs)
62,659
mailchimp_transactional.api.messages_api
search_with_http_info
Search messages by date # noqa: E501 Search recently sent messages and optionally narrow by date range, tags, senders, and API keys. If no date range is specified, results within the last 7 days are returned. This method may be called up to 20 times per minute. If you need the data more often, you can use /messages/info.json to get the information for a single message, or webhooks to push activity to your own application for querying. # noqa: E501
def search_with_http_info(self, body, **kwargs): # noqa: E501 """Search messages by date # noqa: E501 Search recently sent messages and optionally narrow by date range, tags, senders, and API keys. If no date range is specified, results within the last 7 days are returned. This method may be called up to 20 times per minute. If you need the data more often, you can use /messages/info.json to get the information for a single message, or webhooks to push activity to your own application for querying. # 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( '/messages/search', 'POST', body=body_params, response_type='list[InlineResponse20030]') # noqa: E501
(self, body, **kwargs)
62,660
mailchimp_transactional.api.messages_api
send
Send new message # noqa: E501 Send a new transactional message through the Transactional API. # noqa: E501
def send(self, body = {}, **kwargs): # noqa: E501 """Send new message # noqa: E501 Send a new transactional message through the Transactional API. # noqa: E501 """ (data) = self.send_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,661
mailchimp_transactional.api.messages_api
send_raw
Send mime document # noqa: E501 Take a raw MIME document for a message, and send it exactly as if it were sent through the Transactional API's SMTP servers. # noqa: E501
def send_raw(self, body = {}, **kwargs): # noqa: E501 """Send mime document # noqa: E501 Take a raw MIME document for a message, and send it exactly as if it were sent through the Transactional API's SMTP servers. # noqa: E501 """ (data) = self.send_raw_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,662
mailchimp_transactional.api.messages_api
send_raw_with_http_info
Send mime document # noqa: E501 Take a raw MIME document for a message, and send it exactly as if it were sent through the Transactional API's SMTP servers. # noqa: E501
def send_raw_with_http_info(self, body, **kwargs): # noqa: E501 """Send mime document # noqa: E501 Take a raw MIME document for a message, and send it exactly as if it were sent through the Transactional API's SMTP servers. # 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 send_raw" % 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( '/messages/send-raw', 'POST', body=body_params, response_type='object') # noqa: E501
(self, body, **kwargs)
62,663
mailchimp_transactional.api.messages_api
send_template
Send using message template # noqa: E501 Send a new transactional message through the Transactional API using a template. # noqa: E501
def send_template(self, body = {}, **kwargs): # noqa: E501 """Send using message template # noqa: E501 Send a new transactional message through the Transactional API using a template. # noqa: E501 """ (data) = self.send_template_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,664
mailchimp_transactional.api.messages_api
send_template_with_http_info
Send using message template # noqa: E501 Send a new transactional message through the Transactional API using a template. # noqa: E501
def send_template_with_http_info(self, body, **kwargs): # noqa: E501 """Send using message template # noqa: E501 Send a new transactional message through the Transactional API using 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 send_template" % 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( '/messages/send-template', 'POST', body=body_params, response_type='list[InlineResponse20029]') # noqa: E501
(self, body, **kwargs)
62,665
mailchimp_transactional.api.messages_api
send_with_http_info
Send new message # noqa: E501 Send a new transactional message through the Transactional API. # noqa: E501
def send_with_http_info(self, body, **kwargs): # noqa: E501 """Send new message # noqa: E501 Send a new transactional message through the Transactional API. # 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 send" % 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( '/messages/send', 'POST', body=body_params, response_type='list[InlineResponse20028]') # noqa: E501
(self, body, **kwargs)
62,666
mailchimp_transactional.api.metadata_api
MetadataApi
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 MetadataApi(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 metadata field # noqa: E501 Add a new custom metadata field to be indexed for the account. # 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 metadata field # noqa: E501 Add a new custom metadata field to be indexed for 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 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( '/metadata/add', 'POST', body=body_params, response_type='InlineResponse20037') # noqa: E501 def delete(self, body = {}, **kwargs): # noqa: E501 """Delete metadata field # noqa: E501 Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete. # 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 metadata field # noqa: E501 Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete. # 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( '/metadata/delete', 'POST', body=body_params, response_type='InlineResponse20039') # noqa: E501 def list(self, body = {}, **kwargs): # noqa: E501 """List metadata fields # noqa: E501 Get the list of custom metadata fields indexed for 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 metadata fields # noqa: E501 Get the list of custom metadata fields indexed for 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( '/metadata/list', 'POST', body=body_params, response_type='list[InlineResponse20036]') # noqa: E501 def update(self, body = {}, **kwargs): # noqa: E501 """Update metadata field # noqa: E501 Update an existing custom metadata field. # 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 metadata field # noqa: E501 Update an existing custom metadata field. # 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( '/metadata/update', 'POST', body=body_params, response_type='InlineResponse20038') # noqa: E501
(api_key='', api_client=None)
62,668
mailchimp_transactional.api.metadata_api
add
Add metadata field # noqa: E501 Add a new custom metadata field to be indexed for the account. # noqa: E501
def add(self, body = {}, **kwargs): # noqa: E501 """Add metadata field # noqa: E501 Add a new custom metadata field to be indexed for the account. # noqa: E501 """ (data) = self.add_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,669
mailchimp_transactional.api.metadata_api
add_with_http_info
Add metadata field # noqa: E501 Add a new custom metadata field to be indexed for the account. # noqa: E501
def add_with_http_info(self, body, **kwargs): # noqa: E501 """Add metadata field # noqa: E501 Add a new custom metadata field to be indexed for 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 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( '/metadata/add', 'POST', body=body_params, response_type='InlineResponse20037') # noqa: E501
(self, body, **kwargs)
62,670
mailchimp_transactional.api.metadata_api
delete
Delete metadata field # noqa: E501 Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete. # noqa: E501
def delete(self, body = {}, **kwargs): # noqa: E501 """Delete metadata field # noqa: E501 Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete. # noqa: E501 """ (data) = self.delete_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,671
mailchimp_transactional.api.metadata_api
delete_with_http_info
Delete metadata field # noqa: E501 Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete. # noqa: E501
def delete_with_http_info(self, body, **kwargs): # noqa: E501 """Delete metadata field # noqa: E501 Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete. # 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( '/metadata/delete', 'POST', body=body_params, response_type='InlineResponse20039') # noqa: E501
(self, body, **kwargs)
62,672
mailchimp_transactional.api.metadata_api
list
List metadata fields # noqa: E501 Get the list of custom metadata fields indexed for the account. # noqa: E501
def list(self, body = {}, **kwargs): # noqa: E501 """List metadata fields # noqa: E501 Get the list of custom metadata fields indexed for the account. # noqa: E501 """ (data) = self.list_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,673
mailchimp_transactional.api.metadata_api
list_with_http_info
List metadata fields # noqa: E501 Get the list of custom metadata fields indexed for the account. # noqa: E501
def list_with_http_info(self, body, **kwargs): # noqa: E501 """List metadata fields # noqa: E501 Get the list of custom metadata fields indexed for 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( '/metadata/list', 'POST', body=body_params, response_type='list[InlineResponse20036]') # noqa: E501
(self, body, **kwargs)
62,674
mailchimp_transactional.api.metadata_api
update
Update metadata field # noqa: E501 Update an existing custom metadata field. # noqa: E501
def update(self, body = {}, **kwargs): # noqa: E501 """Update metadata field # noqa: E501 Update an existing custom metadata field. # noqa: E501 """ (data) = self.update_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,675
mailchimp_transactional.api.metadata_api
update_with_http_info
Update metadata field # noqa: E501 Update an existing custom metadata field. # noqa: E501
def update_with_http_info(self, body, **kwargs): # noqa: E501 """Update metadata field # noqa: E501 Update an existing custom metadata field. # 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( '/metadata/update', 'POST', body=body_params, response_type='InlineResponse20038') # noqa: E501
(self, body, **kwargs)
62,676
mailchimp_transactional.api.rejects_api
RejectsApi
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 RejectsApi(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 denylist # noqa: E501 Adds an email to your email rejection denylist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your denylist. Attempting to denylist an address that has been added to the allowlist will have no effect. # 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 denylist # noqa: E501 Adds an email to your email rejection denylist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your denylist. Attempting to denylist an address that has been added to the allowlist will have no effect. # 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( '/rejects/add', 'POST', body=body_params, response_type='InlineResponse20040') # noqa: E501 def delete(self, body = {}, **kwargs): # noqa: E501 """Delete email from denylist # noqa: E501 Deletes an email rejection. There is no limit to how many rejections you can remove from your denylist, but keep in mind that each deletion has an affect on your reputation. # 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 email from denylist # noqa: E501 Deletes an email rejection. There is no limit to how many rejections you can remove from your denylist, but keep in mind that each deletion has an affect on your reputation. # 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( '/rejects/delete', 'POST', body=body_params, response_type='InlineResponse20042') # noqa: E501 def list(self, body = {}, **kwargs): # noqa: E501 """List denylisted emails # noqa: E501 Retrieves your email rejection denylist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them. # 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 denylisted emails # noqa: E501 Retrieves your email rejection denylist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them. # 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( '/rejects/list', 'POST', body=body_params, response_type='list[InlineResponse20041]') # noqa: E501
(api_key='', api_client=None)
62,678
mailchimp_transactional.api.rejects_api
add
Add email to denylist # noqa: E501 Adds an email to your email rejection denylist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your denylist. Attempting to denylist an address that has been added to the allowlist will have no effect. # noqa: E501
def add(self, body = {}, **kwargs): # noqa: E501 """Add email to denylist # noqa: E501 Adds an email to your email rejection denylist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your denylist. Attempting to denylist an address that has been added to the allowlist will have no effect. # noqa: E501 """ (data) = self.add_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,679
mailchimp_transactional.api.rejects_api
add_with_http_info
Add email to denylist # noqa: E501 Adds an email to your email rejection denylist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your denylist. Attempting to denylist an address that has been added to the allowlist will have no effect. # noqa: E501
def add_with_http_info(self, body, **kwargs): # noqa: E501 """Add email to denylist # noqa: E501 Adds an email to your email rejection denylist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your denylist. Attempting to denylist an address that has been added to the allowlist will have no effect. # 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( '/rejects/add', 'POST', body=body_params, response_type='InlineResponse20040') # noqa: E501
(self, body, **kwargs)
62,680
mailchimp_transactional.api.rejects_api
delete
Delete email from denylist # noqa: E501 Deletes an email rejection. There is no limit to how many rejections you can remove from your denylist, but keep in mind that each deletion has an affect on your reputation. # noqa: E501
def delete(self, body = {}, **kwargs): # noqa: E501 """Delete email from denylist # noqa: E501 Deletes an email rejection. There is no limit to how many rejections you can remove from your denylist, but keep in mind that each deletion has an affect on your reputation. # noqa: E501 """ (data) = self.delete_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,681
mailchimp_transactional.api.rejects_api
delete_with_http_info
Delete email from denylist # noqa: E501 Deletes an email rejection. There is no limit to how many rejections you can remove from your denylist, but keep in mind that each deletion has an affect on your reputation. # noqa: E501
def delete_with_http_info(self, body, **kwargs): # noqa: E501 """Delete email from denylist # noqa: E501 Deletes an email rejection. There is no limit to how many rejections you can remove from your denylist, but keep in mind that each deletion has an affect on your reputation. # 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( '/rejects/delete', 'POST', body=body_params, response_type='InlineResponse20042') # noqa: E501
(self, body, **kwargs)
62,682
mailchimp_transactional.api.rejects_api
list
List denylisted emails # noqa: E501 Retrieves your email rejection denylist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them. # noqa: E501
def list(self, body = {}, **kwargs): # noqa: E501 """List denylisted emails # noqa: E501 Retrieves your email rejection denylist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them. # noqa: E501 """ (data) = self.list_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,683
mailchimp_transactional.api.rejects_api
list_with_http_info
List denylisted emails # noqa: E501 Retrieves your email rejection denylist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them. # noqa: E501
def list_with_http_info(self, body, **kwargs): # noqa: E501 """List denylisted emails # noqa: E501 Retrieves your email rejection denylist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them. # 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( '/rejects/list', 'POST', body=body_params, response_type='list[InlineResponse20041]') # noqa: E501
(self, body, **kwargs)
62,684
mailchimp_transactional.api.senders_api
SendersApi
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 SendersApi(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_domain(self, body = {}, **kwargs): # noqa: E501 """Add sender domain # noqa: E501 Adds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time. # noqa: E501 """ (data) = self.add_domain_with_http_info(body, **kwargs) # noqa: E501 return data def add_domain_with_http_info(self, body, **kwargs): # noqa: E501 """Add sender domain # noqa: E501 Adds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time. # 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_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/add-domain', 'POST', body=body_params, response_type='InlineResponse20045') # noqa: E501 def check_domain(self, body = {}, **kwargs): # noqa: E501 """Check domain settings # noqa: E501 Checks the SPF and DKIM settings for a domain, as well the domain verification. If you haven't already added this domain to your account, it will be added automatically. # noqa: E501 """ (data) = self.check_domain_with_http_info(body, **kwargs) # noqa: E501 return data def check_domain_with_http_info(self, body, **kwargs): # noqa: E501 """Check domain settings # noqa: E501 Checks the SPF and DKIM settings for a domain, as well the domain verification. If you haven't already added this domain to your account, it will be added 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 check_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/check-domain', 'POST', body=body_params, response_type='InlineResponse20046') # noqa: E501 def domains(self, body = {}, **kwargs): # noqa: E501 """List sender domains # noqa: E501 Returns the sender domains that have been added to this account. # noqa: E501 """ (data) = self.domains_with_http_info(body, **kwargs) # noqa: E501 return data def domains_with_http_info(self, body, **kwargs): # noqa: E501 """List sender domains # noqa: E501 Returns the sender domains that have been added to 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 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( '/senders/domains', 'POST', body=body_params, response_type='list[InlineResponse20044]') # noqa: E501 def 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 """ (data) = self.info_with_http_info(body, **kwargs) # noqa: E501 return data 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 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 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 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 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 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 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
(api_key='', api_client=None)
62,686
mailchimp_transactional.api.senders_api
add_domain
Add sender domain # noqa: E501 Adds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time. # noqa: E501
def add_domain(self, body = {}, **kwargs): # noqa: E501 """Add sender domain # noqa: E501 Adds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time. # noqa: E501 """ (data) = self.add_domain_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,687
mailchimp_transactional.api.senders_api
add_domain_with_http_info
Add sender domain # noqa: E501 Adds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time. # noqa: E501
def add_domain_with_http_info(self, body, **kwargs): # noqa: E501 """Add sender domain # noqa: E501 Adds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time. # 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_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/add-domain', 'POST', body=body_params, response_type='InlineResponse20045') # noqa: E501
(self, body, **kwargs)
62,688
mailchimp_transactional.api.senders_api
check_domain
Check domain settings # noqa: E501 Checks the SPF and DKIM settings for a domain, as well the domain verification. If you haven't already added this domain to your account, it will be added automatically. # noqa: E501
def check_domain(self, body = {}, **kwargs): # noqa: E501 """Check domain settings # noqa: E501 Checks the SPF and DKIM settings for a domain, as well the domain verification. If you haven't already added this domain to your account, it will be added automatically. # noqa: E501 """ (data) = self.check_domain_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,689
mailchimp_transactional.api.senders_api
check_domain_with_http_info
Check domain settings # noqa: E501 Checks the SPF and DKIM settings for a domain, as well the domain verification. If you haven't already added this domain to your account, it will be added automatically. # noqa: E501
def check_domain_with_http_info(self, body, **kwargs): # noqa: E501 """Check domain settings # noqa: E501 Checks the SPF and DKIM settings for a domain, as well the domain verification. If you haven't already added this domain to your account, it will be added 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 check_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/check-domain', 'POST', body=body_params, response_type='InlineResponse20046') # noqa: E501
(self, body, **kwargs)
62,690
mailchimp_transactional.api.senders_api
domains
List sender domains # noqa: E501 Returns the sender domains that have been added to this account. # noqa: E501
def domains(self, body = {}, **kwargs): # noqa: E501 """List sender domains # noqa: E501 Returns the sender domains that have been added to this account. # noqa: E501 """ (data) = self.domains_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)
62,691
mailchimp_transactional.api.senders_api
domains_with_http_info
List sender domains # noqa: E501 Returns the sender domains that have been added to this account. # noqa: E501
def domains_with_http_info(self, body, **kwargs): # noqa: E501 """List sender domains # noqa: E501 Returns the sender domains that have been added to 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 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( '/senders/domains', 'POST', body=body_params, response_type='list[InlineResponse20044]') # noqa: E501
(self, body, **kwargs)
62,692
mailchimp_transactional.api.senders_api
info
Get sender info # noqa: E501 Return more detailed information about a single sender, including aggregates of recent stats. # noqa: E501
def 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 """ (data) = self.info_with_http_info(body, **kwargs) # noqa: E501 return data
(self, body={}, **kwargs)