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
⌀ |
|---|---|---|---|---|---|
69,445 |
mailchimp_marketing.api.lists_api
|
update_list_member_note
|
Update note # noqa: E501
Update a specific note for a specific list member. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_member_note(list_id, subscriber_hash, note_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. (required)
:param str note_id: The id for the note. (required)
:param MemberNotes2 body: (required)
:return: MemberNotes
If the method is called asynchronously,
returns the request thread.
|
def update_list_member_note(self, list_id, subscriber_hash, note_id, body, **kwargs): # noqa: E501
"""Update note # noqa: E501
Update a specific note for a specific list member. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_member_note(list_id, subscriber_hash, note_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. (required)
:param str note_id: The id for the note. (required)
:param MemberNotes2 body: (required)
:return: MemberNotes
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.update_list_member_note_with_http_info(list_id, subscriber_hash, note_id, body, **kwargs) # noqa: E501
else:
(data) = self.update_list_member_note_with_http_info(list_id, subscriber_hash, note_id, body, **kwargs) # noqa: E501
return data
|
(self, list_id, subscriber_hash, note_id, body, **kwargs)
|
69,446 |
mailchimp_marketing.api.lists_api
|
update_list_member_note_with_http_info
|
Update note # noqa: E501
Update a specific note for a specific list member. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_member_note_with_http_info(list_id, subscriber_hash, note_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. (required)
:param str note_id: The id for the note. (required)
:param MemberNotes2 body: (required)
:return: MemberNotes
If the method is called asynchronously,
returns the request thread.
|
def update_list_member_note_with_http_info(self, list_id, subscriber_hash, note_id, body, **kwargs): # noqa: E501
"""Update note # noqa: E501
Update a specific note for a specific list member. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_member_note_with_http_info(list_id, subscriber_hash, note_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. (required)
:param str note_id: The id for the note. (required)
:param MemberNotes2 body: (required)
:return: MemberNotes
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['list_id', 'subscriber_hash', 'note_id', 'body'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_list_member_note" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'list_id' is set
if ('list_id' not in params or
params['list_id'] is None):
raise ValueError("Missing the required parameter `list_id` when calling ``") # noqa: E501
# verify the required parameter 'subscriber_hash' is set
if ('subscriber_hash' not in params or
params['subscriber_hash'] is None):
raise ValueError("Missing the required parameter `subscriber_hash` when calling ``") # noqa: E501
# verify the required parameter 'note_id' is set
if ('note_id' not in params or
params['note_id'] is None):
raise ValueError("Missing the required parameter `note_id` when calling ``") # noqa: E501
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'list_id' in params:
path_params['list_id'] = params['list_id'] # noqa: E501
if 'subscriber_hash' in params:
path_params['subscriber_hash'] = params['subscriber_hash'] # noqa: E501
if 'note_id' in params:
path_params['note_id'] = params['note_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}', 'PATCH',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='MemberNotes', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, list_id, subscriber_hash, note_id, body, **kwargs)
|
69,447 |
mailchimp_marketing.api.lists_api
|
update_list_member_tags
|
Add or remove member tags # noqa: E501
Add or remove tags from a list member. If a tag that does not exist is passed in and set as 'active', a new tag will be created. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_member_tags(list_id, subscriber_hash, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param MemberTags body: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_list_member_tags(self, list_id, subscriber_hash, body, **kwargs): # noqa: E501
"""Add or remove member tags # noqa: E501
Add or remove tags from a list member. If a tag that does not exist is passed in and set as 'active', a new tag will be created. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_member_tags(list_id, subscriber_hash, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param MemberTags body: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.update_list_member_tags_with_http_info(list_id, subscriber_hash, body, **kwargs) # noqa: E501
else:
(data) = self.update_list_member_tags_with_http_info(list_id, subscriber_hash, body, **kwargs) # noqa: E501
return data
|
(self, list_id, subscriber_hash, body, **kwargs)
|
69,448 |
mailchimp_marketing.api.lists_api
|
update_list_member_tags_with_http_info
|
Add or remove member tags # noqa: E501
Add or remove tags from a list member. If a tag that does not exist is passed in and set as 'active', a new tag will be created. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_member_tags_with_http_info(list_id, subscriber_hash, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param MemberTags body: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def update_list_member_tags_with_http_info(self, list_id, subscriber_hash, body, **kwargs): # noqa: E501
"""Add or remove member tags # noqa: E501
Add or remove tags from a list member. If a tag that does not exist is passed in and set as 'active', a new tag will be created. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_member_tags_with_http_info(list_id, subscriber_hash, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param MemberTags body: (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['list_id', 'subscriber_hash', 'body'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_list_member_tags" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'list_id' is set
if ('list_id' not in params or
params['list_id'] is None):
raise ValueError("Missing the required parameter `list_id` when calling ``") # noqa: E501
# verify the required parameter 'subscriber_hash' is set
if ('subscriber_hash' not in params or
params['subscriber_hash'] is None):
raise ValueError("Missing the required parameter `subscriber_hash` when calling ``") # noqa: E501
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'list_id' in params:
path_params['list_id'] = params['list_id'] # noqa: E501
if 'subscriber_hash' in params:
path_params['subscriber_hash'] = params['subscriber_hash'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/lists/{list_id}/members/{subscriber_hash}/tags', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, list_id, subscriber_hash, body, **kwargs)
|
69,449 |
mailchimp_marketing.api.lists_api
|
update_list_member_with_http_info
|
Update list member # noqa: E501
Update information for a specific list member. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_member_with_http_info(list_id, subscriber_hash, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. (required)
:param AddListMembers3 body: (required)
:param bool skip_merge_validation: If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false.
:return: ListMembers2
If the method is called asynchronously,
returns the request thread.
|
def update_list_member_with_http_info(self, list_id, subscriber_hash, body, **kwargs): # noqa: E501
"""Update list member # noqa: E501
Update information for a specific list member. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_member_with_http_info(list_id, subscriber_hash, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. (required)
:param AddListMembers3 body: (required)
:param bool skip_merge_validation: If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false.
:return: ListMembers2
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['list_id', 'subscriber_hash', 'body', 'skip_merge_validation'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_list_member" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'list_id' is set
if ('list_id' not in params or
params['list_id'] is None):
raise ValueError("Missing the required parameter `list_id` when calling ``") # noqa: E501
# verify the required parameter 'subscriber_hash' is set
if ('subscriber_hash' not in params or
params['subscriber_hash'] is None):
raise ValueError("Missing the required parameter `subscriber_hash` when calling ``") # noqa: E501
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'list_id' in params:
path_params['list_id'] = params['list_id'] # noqa: E501
if 'subscriber_hash' in params:
path_params['subscriber_hash'] = params['subscriber_hash'] # noqa: E501
query_params = []
if 'skip_merge_validation' in params:
query_params.append(('skip_merge_validation', params['skip_merge_validation'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/lists/{list_id}/members/{subscriber_hash}', 'PATCH',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ListMembers2', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, list_id, subscriber_hash, body, **kwargs)
|
69,450 |
mailchimp_marketing.api.lists_api
|
update_list_merge_field
|
Update merge field # noqa: E501
Update a specific merge field. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_merge_field(list_id, merge_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str merge_id: The id for the merge field. (required)
:param MergeField2 body: (required)
:return: MergeField
If the method is called asynchronously,
returns the request thread.
|
def update_list_merge_field(self, list_id, merge_id, body, **kwargs): # noqa: E501
"""Update merge field # noqa: E501
Update a specific merge field. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_merge_field(list_id, merge_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str merge_id: The id for the merge field. (required)
:param MergeField2 body: (required)
:return: MergeField
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.update_list_merge_field_with_http_info(list_id, merge_id, body, **kwargs) # noqa: E501
else:
(data) = self.update_list_merge_field_with_http_info(list_id, merge_id, body, **kwargs) # noqa: E501
return data
|
(self, list_id, merge_id, body, **kwargs)
|
69,451 |
mailchimp_marketing.api.lists_api
|
update_list_merge_field_with_http_info
|
Update merge field # noqa: E501
Update a specific merge field. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_merge_field_with_http_info(list_id, merge_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str merge_id: The id for the merge field. (required)
:param MergeField2 body: (required)
:return: MergeField
If the method is called asynchronously,
returns the request thread.
|
def update_list_merge_field_with_http_info(self, list_id, merge_id, body, **kwargs): # noqa: E501
"""Update merge field # noqa: E501
Update a specific merge field. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_merge_field_with_http_info(list_id, merge_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str merge_id: The id for the merge field. (required)
:param MergeField2 body: (required)
:return: MergeField
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['list_id', 'merge_id', 'body'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_list_merge_field" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'list_id' is set
if ('list_id' not in params or
params['list_id'] is None):
raise ValueError("Missing the required parameter `list_id` when calling ``") # noqa: E501
# verify the required parameter 'merge_id' is set
if ('merge_id' not in params or
params['merge_id'] is None):
raise ValueError("Missing the required parameter `merge_id` when calling ``") # noqa: E501
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'list_id' in params:
path_params['list_id'] = params['list_id'] # noqa: E501
if 'merge_id' in params:
path_params['merge_id'] = params['merge_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/lists/{list_id}/merge-fields/{merge_id}', 'PATCH',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='MergeField', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, list_id, merge_id, body, **kwargs)
|
69,452 |
mailchimp_marketing.api.lists_api
|
update_list_signup_form
|
Customize signup form # noqa: E501
Customize a list's default signup form. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_signup_form(list_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param SignupForm1 body: (required)
:return: SignupForm
If the method is called asynchronously,
returns the request thread.
|
def update_list_signup_form(self, list_id, body, **kwargs): # noqa: E501
"""Customize signup form # noqa: E501
Customize a list's default signup form. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_signup_form(list_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param SignupForm1 body: (required)
:return: SignupForm
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.update_list_signup_form_with_http_info(list_id, body, **kwargs) # noqa: E501
else:
(data) = self.update_list_signup_form_with_http_info(list_id, body, **kwargs) # noqa: E501
return data
|
(self, list_id, body, **kwargs)
|
69,453 |
mailchimp_marketing.api.lists_api
|
update_list_signup_form_with_http_info
|
Customize signup form # noqa: E501
Customize a list's default signup form. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_signup_form_with_http_info(list_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param SignupForm1 body: (required)
:return: SignupForm
If the method is called asynchronously,
returns the request thread.
|
def update_list_signup_form_with_http_info(self, list_id, body, **kwargs): # noqa: E501
"""Customize signup form # noqa: E501
Customize a list's default signup form. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_signup_form_with_http_info(list_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param SignupForm1 body: (required)
:return: SignupForm
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['list_id', 'body'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_list_signup_form" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'list_id' is set
if ('list_id' not in params or
params['list_id'] is None):
raise ValueError("Missing the required parameter `list_id` when calling ``") # noqa: E501
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'list_id' in params:
path_params['list_id'] = params['list_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/lists/{list_id}/signup-forms', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SignupForm', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, list_id, body, **kwargs)
|
69,454 |
mailchimp_marketing.api.lists_api
|
update_list_webhook
|
Update webhook # noqa: E501
Update the settings for an existing webhook. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_webhook(list_id, webhook_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str webhook_id: The webhook's id. (required)
:param AddWebhook1 body: (required)
:return: ListWebhooks
If the method is called asynchronously,
returns the request thread.
|
def update_list_webhook(self, list_id, webhook_id, body, **kwargs): # noqa: E501
"""Update webhook # noqa: E501
Update the settings for an existing webhook. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_webhook(list_id, webhook_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str webhook_id: The webhook's id. (required)
:param AddWebhook1 body: (required)
:return: ListWebhooks
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.update_list_webhook_with_http_info(list_id, webhook_id, body, **kwargs) # noqa: E501
else:
(data) = self.update_list_webhook_with_http_info(list_id, webhook_id, body, **kwargs) # noqa: E501
return data
|
(self, list_id, webhook_id, body, **kwargs)
|
69,455 |
mailchimp_marketing.api.lists_api
|
update_list_webhook_with_http_info
|
Update webhook # noqa: E501
Update the settings for an existing webhook. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_webhook_with_http_info(list_id, webhook_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str webhook_id: The webhook's id. (required)
:param AddWebhook1 body: (required)
:return: ListWebhooks
If the method is called asynchronously,
returns the request thread.
|
def update_list_webhook_with_http_info(self, list_id, webhook_id, body, **kwargs): # noqa: E501
"""Update webhook # noqa: E501
Update the settings for an existing webhook. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_webhook_with_http_info(list_id, webhook_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str webhook_id: The webhook's id. (required)
:param AddWebhook1 body: (required)
:return: ListWebhooks
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['list_id', 'webhook_id', 'body'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_list_webhook" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'list_id' is set
if ('list_id' not in params or
params['list_id'] is None):
raise ValueError("Missing the required parameter `list_id` when calling ``") # noqa: E501
# verify the required parameter 'webhook_id' is set
if ('webhook_id' not in params or
params['webhook_id'] is None):
raise ValueError("Missing the required parameter `webhook_id` when calling ``") # noqa: E501
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'list_id' in params:
path_params['list_id'] = params['list_id'] # noqa: E501
if 'webhook_id' in params:
path_params['webhook_id'] = params['webhook_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/lists/{list_id}/webhooks/{webhook_id}', 'PATCH',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ListWebhooks', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, list_id, webhook_id, body, **kwargs)
|
69,456 |
mailchimp_marketing.api.lists_api
|
update_list_with_http_info
|
Update lists # noqa: E501
Update the settings for a specific list. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_with_http_info(list_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param SubscriberList2 body: (required)
:return: SubscriberList
If the method is called asynchronously,
returns the request thread.
|
def update_list_with_http_info(self, list_id, body, **kwargs): # noqa: E501
"""Update lists # noqa: E501
Update the settings for a specific list. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_list_with_http_info(list_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param SubscriberList2 body: (required)
:return: SubscriberList
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['list_id', 'body'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_list" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'list_id' is set
if ('list_id' not in params or
params['list_id'] is None):
raise ValueError("Missing the required parameter `list_id` when calling ``") # noqa: E501
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'list_id' in params:
path_params['list_id'] = params['list_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/lists/{list_id}', 'PATCH',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SubscriberList', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, list_id, body, **kwargs)
|
69,457 |
mailchimp_marketing.api.lists_api
|
update_segment
|
Update segment # noqa: E501
Update a specific segment in a list. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_segment(list_id, segment_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str segment_id: The unique id for the segment. (required)
:param List9 body: (required)
:return: List7
If the method is called asynchronously,
returns the request thread.
|
def update_segment(self, list_id, segment_id, body, **kwargs): # noqa: E501
"""Update segment # noqa: E501
Update a specific segment in a list. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_segment(list_id, segment_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str segment_id: The unique id for the segment. (required)
:param List9 body: (required)
:return: List7
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.update_segment_with_http_info(list_id, segment_id, body, **kwargs) # noqa: E501
else:
(data) = self.update_segment_with_http_info(list_id, segment_id, body, **kwargs) # noqa: E501
return data
|
(self, list_id, segment_id, body, **kwargs)
|
69,458 |
mailchimp_marketing.api.lists_api
|
update_segment_with_http_info
|
Update segment # noqa: E501
Update a specific segment in a list. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_segment_with_http_info(list_id, segment_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str segment_id: The unique id for the segment. (required)
:param List9 body: (required)
:return: List7
If the method is called asynchronously,
returns the request thread.
|
def update_segment_with_http_info(self, list_id, segment_id, body, **kwargs): # noqa: E501
"""Update segment # noqa: E501
Update a specific segment in a list. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_segment_with_http_info(list_id, segment_id, body, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str segment_id: The unique id for the segment. (required)
:param List9 body: (required)
:return: List7
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['list_id', 'segment_id', 'body'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method update_segment" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'list_id' is set
if ('list_id' not in params or
params['list_id'] is None):
raise ValueError("Missing the required parameter `list_id` when calling ``") # noqa: E501
# verify the required parameter 'segment_id' is set
if ('segment_id' not in params or
params['segment_id'] is None):
raise ValueError("Missing the required parameter `segment_id` when calling ``") # noqa: E501
# verify the required parameter 'body' is set
if ('body' not in params or
params['body'] is None):
raise ValueError("Missing the required parameter `body` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'list_id' in params:
path_params['list_id'] = params['list_id'] # noqa: E501
if 'segment_id' in params:
path_params['segment_id'] = params['segment_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/lists/{list_id}/segments/{segment_id}', 'PATCH',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='List7', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, list_id, segment_id, body, **kwargs)
|
69,459 |
mailchimp_marketing.api.ping_api
|
PingApi
|
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 PingApi(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_client):
self.api_client = api_client
def get(self, **kwargs): # noqa: E501
"""Ping # noqa: E501
A health check for the API that won't return any account-specific information. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: APIHealthStatus
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_with_http_info(**kwargs) # noqa: E501
return data
def get_with_http_info(self, **kwargs): # noqa: E501
"""Ping # noqa: E501
A health check for the API that won't return any account-specific information. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: APIHealthStatus
If the method is called asynchronously,
returns the request thread.
"""
all_params = [] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/ping', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='APIHealthStatus', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(api_client)
|
69,461 |
mailchimp_marketing.api.ping_api
|
get
|
Ping # noqa: E501
A health check for the API that won't return any account-specific information. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: APIHealthStatus
If the method is called asynchronously,
returns the request thread.
|
def get(self, **kwargs): # noqa: E501
"""Ping # noqa: E501
A health check for the API that won't return any account-specific information. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: APIHealthStatus
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
69,462 |
mailchimp_marketing.api.ping_api
|
get_with_http_info
|
Ping # noqa: E501
A health check for the API that won't return any account-specific information. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: APIHealthStatus
If the method is called asynchronously,
returns the request thread.
|
def get_with_http_info(self, **kwargs): # noqa: E501
"""Ping # noqa: E501
A health check for the API that won't return any account-specific information. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: APIHealthStatus
If the method is called asynchronously,
returns the request thread.
"""
all_params = [] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/ping', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='APIHealthStatus', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, **kwargs)
|
69,463 |
mailchimp_marketing.api.reporting_api
|
ReportingApi
|
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 ReportingApi(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_client):
self.api_client = api_client
def get_facebook_ads_report_all(self, **kwargs): # noqa: E501
"""List facebook ads reports # noqa: E501
Get reports of Facebook ads. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_facebook_ads_report_all(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str sort_field: Returns files sorted by the specified field.
:param str sort_dir: Determines the order direction for sorted results.
:return: InlineResponse20010
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_facebook_ads_report_all_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_facebook_ads_report_all_with_http_info(**kwargs) # noqa: E501
return data
def get_facebook_ads_report_all_with_http_info(self, **kwargs): # noqa: E501
"""List facebook ads reports # noqa: E501
Get reports of Facebook ads. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_facebook_ads_report_all_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str sort_field: Returns files sorted by the specified field.
:param str sort_dir: Determines the order direction for sorted results.
:return: InlineResponse20010
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['fields', 'exclude_fields', 'count', 'offset', 'sort_field', 'sort_dir'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_facebook_ads_report_all" % key
)
params[key] = val
del params['kwargs']
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'sort_field' in params:
query_params.append(('sort_field', params['sort_field'])) # noqa: E501
if 'sort_dir' in params:
query_params.append(('sort_dir', params['sort_dir'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/facebook-ads', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse20010', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_facebook_ad_report(self, outreach_id, **kwargs): # noqa: E501
"""Get facebook ad report # noqa: E501
Get report of a Facebook ad. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_facebook_ad_report(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: InlineResponse20011
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_facebook_ad_report_with_http_info(outreach_id, **kwargs) # noqa: E501
else:
(data) = self.get_facebook_ad_report_with_http_info(outreach_id, **kwargs) # noqa: E501
return data
def get_facebook_ad_report_with_http_info(self, outreach_id, **kwargs): # noqa: E501
"""Get facebook ad report # noqa: E501
Get report of a Facebook ad. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_facebook_ad_report_with_http_info(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: InlineResponse20011
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['outreach_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_facebook_ad_report" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'outreach_id' is set
if ('outreach_id' not in params or
params['outreach_id'] is None):
raise ValueError("Missing the required parameter `outreach_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'outreach_id' in params:
path_params['outreach_id'] = params['outreach_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/facebook-ads/{outreach_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse20011', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_facebook_ad_product_activity_report(self, outreach_id, **kwargs): # noqa: E501
"""List facebook ecommerce report # noqa: E501
Get breakdown of product activity for an outreach. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_facebook_ad_product_activity_report(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str sort_field: Returns files sorted by the specified field.
:return: InlineResponse2007
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_facebook_ad_product_activity_report_with_http_info(outreach_id, **kwargs) # noqa: E501
else:
(data) = self.get_facebook_ad_product_activity_report_with_http_info(outreach_id, **kwargs) # noqa: E501
return data
def get_facebook_ad_product_activity_report_with_http_info(self, outreach_id, **kwargs): # noqa: E501
"""List facebook ecommerce report # noqa: E501
Get breakdown of product activity for an outreach. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_facebook_ad_product_activity_report_with_http_info(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str sort_field: Returns files sorted by the specified field.
:return: InlineResponse2007
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['outreach_id', 'fields', 'exclude_fields', 'count', 'offset', 'sort_field'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_facebook_ad_product_activity_report" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'outreach_id' is set
if ('outreach_id' not in params or
params['outreach_id'] is None):
raise ValueError("Missing the required parameter `outreach_id` when calling ``") # noqa: E501
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
if 'outreach_id' in params:
path_params['outreach_id'] = params['outreach_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'sort_field' in params:
query_params.append(('sort_field', params['sort_field'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/facebook-ads/{outreach_id}/ecommerce-product-activity', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse2007', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_landing_page_reports_all(self, **kwargs): # noqa: E501
"""List landing pages reports # noqa: E501
Get reports of landing pages. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_landing_page_reports_all(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: InlineResponse20012
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_landing_page_reports_all_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_landing_page_reports_all_with_http_info(**kwargs) # noqa: E501
return data
def get_landing_page_reports_all_with_http_info(self, **kwargs): # noqa: E501
"""List landing pages reports # noqa: E501
Get reports of landing pages. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_landing_page_reports_all_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: InlineResponse20012
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['fields', 'exclude_fields', 'count', 'offset'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_landing_page_reports_all" % key
)
params[key] = val
del params['kwargs']
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/landing-pages', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse20012', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_landing_page_report(self, outreach_id, **kwargs): # noqa: E501
"""Get landing page report # noqa: E501
Get report of a landing page. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_landing_page_report(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: LandingPageReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_landing_page_report_with_http_info(outreach_id, **kwargs) # noqa: E501
else:
(data) = self.get_landing_page_report_with_http_info(outreach_id, **kwargs) # noqa: E501
return data
def get_landing_page_report_with_http_info(self, outreach_id, **kwargs): # noqa: E501
"""Get landing page report # noqa: E501
Get report of a landing page. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_landing_page_report_with_http_info(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: LandingPageReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['outreach_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_landing_page_report" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'outreach_id' is set
if ('outreach_id' not in params or
params['outreach_id'] is None):
raise ValueError("Missing the required parameter `outreach_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'outreach_id' in params:
path_params['outreach_id'] = params['outreach_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/landing-pages/{outreach_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='LandingPageReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_survey_reports_all(self, **kwargs): # noqa: E501
"""List survey reports # noqa: E501
Get reports for surveys. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_reports_all(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: InlineResponse20013
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_survey_reports_all_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_survey_reports_all_with_http_info(**kwargs) # noqa: E501
return data
def get_survey_reports_all_with_http_info(self, **kwargs): # noqa: E501
"""List survey reports # noqa: E501
Get reports for surveys. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_reports_all_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: InlineResponse20013
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['fields', 'exclude_fields', 'count', 'offset'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_survey_reports_all" % key
)
params[key] = val
del params['kwargs']
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/surveys', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse20013', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_survey_report(self, outreach_id, **kwargs): # noqa: E501
"""Get survey report # noqa: E501
Get report for a survey. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_report(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: SurveyReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_survey_report_with_http_info(outreach_id, **kwargs) # noqa: E501
else:
(data) = self.get_survey_report_with_http_info(outreach_id, **kwargs) # noqa: E501
return data
def get_survey_report_with_http_info(self, outreach_id, **kwargs): # noqa: E501
"""Get survey report # noqa: E501
Get report for a survey. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_report_with_http_info(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: SurveyReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['outreach_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_survey_report" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'outreach_id' is set
if ('outreach_id' not in params or
params['outreach_id'] is None):
raise ValueError("Missing the required parameter `outreach_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'outreach_id' in params:
path_params['outreach_id'] = params['outreach_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/surveys/{outreach_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SurveyReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_survey_question_reports_all(self, outreach_id, **kwargs): # noqa: E501
"""List survey question reports # noqa: E501
Get reports for survey questions. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_question_reports_all(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: InlineResponse20014
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_survey_question_reports_all_with_http_info(outreach_id, **kwargs) # noqa: E501
else:
(data) = self.get_survey_question_reports_all_with_http_info(outreach_id, **kwargs) # noqa: E501
return data
def get_survey_question_reports_all_with_http_info(self, outreach_id, **kwargs): # noqa: E501
"""List survey question reports # noqa: E501
Get reports for survey questions. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_question_reports_all_with_http_info(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: InlineResponse20014
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['outreach_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_survey_question_reports_all" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'outreach_id' is set
if ('outreach_id' not in params or
params['outreach_id'] is None):
raise ValueError("Missing the required parameter `outreach_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'outreach_id' in params:
path_params['outreach_id'] = params['outreach_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/surveys/{outreach_id}/questions', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse20014', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_survey_question_report(self, outreach_id, question_id, **kwargs): # noqa: E501
"""Get survey question report # noqa: E501
Get report for a survey question. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_question_report(outreach_id, question_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param str question_id: The ID of the survey question. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: SurveyQuestionReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_survey_question_report_with_http_info(outreach_id, question_id, **kwargs) # noqa: E501
else:
(data) = self.get_survey_question_report_with_http_info(outreach_id, question_id, **kwargs) # noqa: E501
return data
def get_survey_question_report_with_http_info(self, outreach_id, question_id, **kwargs): # noqa: E501
"""Get survey question report # noqa: E501
Get report for a survey question. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_question_report_with_http_info(outreach_id, question_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param str question_id: The ID of the survey question. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: SurveyQuestionReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['outreach_id', 'question_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_survey_question_report" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'outreach_id' is set
if ('outreach_id' not in params or
params['outreach_id'] is None):
raise ValueError("Missing the required parameter `outreach_id` when calling ``") # noqa: E501
# verify the required parameter 'question_id' is set
if ('question_id' not in params or
params['question_id'] is None):
raise ValueError("Missing the required parameter `question_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'outreach_id' in params:
path_params['outreach_id'] = params['outreach_id'] # noqa: E501
if 'question_id' in params:
path_params['question_id'] = params['question_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/surveys/{outreach_id}/questions/{question_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SurveyQuestionReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_survey_question_answers(self, outreach_id, question_id, **kwargs): # noqa: E501
"""List answers for question # noqa: E501
Get answers for a survey question. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_question_answers(outreach_id, question_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param str question_id: The ID of the survey question. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param str respondent_familiarity_is: Filter survey responses by familiarity of the respondents.
:return: InlineResponse20015
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_survey_question_answers_with_http_info(outreach_id, question_id, **kwargs) # noqa: E501
else:
(data) = self.get_survey_question_answers_with_http_info(outreach_id, question_id, **kwargs) # noqa: E501
return data
def get_survey_question_answers_with_http_info(self, outreach_id, question_id, **kwargs): # noqa: E501
"""List answers for question # noqa: E501
Get answers for a survey question. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_question_answers_with_http_info(outreach_id, question_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param str question_id: The ID of the survey question. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param str respondent_familiarity_is: Filter survey responses by familiarity of the respondents.
:return: InlineResponse20015
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['outreach_id', 'question_id', 'fields', 'exclude_fields', 'respondent_familiarity_is'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_survey_question_answers" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'outreach_id' is set
if ('outreach_id' not in params or
params['outreach_id'] is None):
raise ValueError("Missing the required parameter `outreach_id` when calling ``") # noqa: E501
# verify the required parameter 'question_id' is set
if ('question_id' not in params or
params['question_id'] is None):
raise ValueError("Missing the required parameter `question_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'outreach_id' in params:
path_params['outreach_id'] = params['outreach_id'] # noqa: E501
if 'question_id' in params:
path_params['question_id'] = params['question_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'respondent_familiarity_is' in params:
query_params.append(('respondent_familiarity_is', params['respondent_familiarity_is'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/surveys/{outreach_id}/questions/{question_id}/answers', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse20015', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_survey_responses_all(self, outreach_id, **kwargs): # noqa: E501
"""List survey responses # noqa: E501
Get responses to a survey. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_responses_all(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int answered_question: The ID of the question that was answered.
:param str chose_answer: The ID of the option chosen to filter responses on.
:param str respondent_familiarity_is: Filter survey responses by familiarity of the respondents.
:return: InlineResponse20016
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_survey_responses_all_with_http_info(outreach_id, **kwargs) # noqa: E501
else:
(data) = self.get_survey_responses_all_with_http_info(outreach_id, **kwargs) # noqa: E501
return data
def get_survey_responses_all_with_http_info(self, outreach_id, **kwargs): # noqa: E501
"""List survey responses # noqa: E501
Get responses to a survey. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_responses_all_with_http_info(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int answered_question: The ID of the question that was answered.
:param str chose_answer: The ID of the option chosen to filter responses on.
:param str respondent_familiarity_is: Filter survey responses by familiarity of the respondents.
:return: InlineResponse20016
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['outreach_id', 'fields', 'exclude_fields', 'answered_question', 'chose_answer', 'respondent_familiarity_is'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_survey_responses_all" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'outreach_id' is set
if ('outreach_id' not in params or
params['outreach_id'] is None):
raise ValueError("Missing the required parameter `outreach_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'outreach_id' in params:
path_params['outreach_id'] = params['outreach_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'answered_question' in params:
query_params.append(('answered_question', params['answered_question'])) # noqa: E501
if 'chose_answer' in params:
query_params.append(('chose_answer', params['chose_answer'])) # noqa: E501
if 'respondent_familiarity_is' in params:
query_params.append(('respondent_familiarity_is', params['respondent_familiarity_is'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/surveys/{outreach_id}/responses', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse20016', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_survey_response(self, outreach_id, response_id, **kwargs): # noqa: E501
"""Get survey response # noqa: E501
Get a single survey response. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_response(outreach_id, response_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param str response_id: The ID of the survey response. (required)
:return: SurveyResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_survey_response_with_http_info(outreach_id, response_id, **kwargs) # noqa: E501
else:
(data) = self.get_survey_response_with_http_info(outreach_id, response_id, **kwargs) # noqa: E501
return data
def get_survey_response_with_http_info(self, outreach_id, response_id, **kwargs): # noqa: E501
"""Get survey response # noqa: E501
Get a single survey response. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_response_with_http_info(outreach_id, response_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param str response_id: The ID of the survey response. (required)
:return: SurveyResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['outreach_id', 'response_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_survey_response" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'outreach_id' is set
if ('outreach_id' not in params or
params['outreach_id'] is None):
raise ValueError("Missing the required parameter `outreach_id` when calling ``") # noqa: E501
# verify the required parameter 'response_id' is set
if ('response_id' not in params or
params['response_id'] is None):
raise ValueError("Missing the required parameter `response_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'outreach_id' in params:
path_params['outreach_id'] = params['outreach_id'] # noqa: E501
if 'response_id' in params:
path_params['response_id'] = params['response_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/surveys/{outreach_id}/responses/{response_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SurveyResponse', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(api_client)
|
69,465 |
mailchimp_marketing.api.reporting_api
|
get_facebook_ad_product_activity_report
|
List facebook ecommerce report # noqa: E501
Get breakdown of product activity for an outreach. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_facebook_ad_product_activity_report(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str sort_field: Returns files sorted by the specified field.
:return: InlineResponse2007
If the method is called asynchronously,
returns the request thread.
|
def get_facebook_ad_product_activity_report(self, outreach_id, **kwargs): # noqa: E501
"""List facebook ecommerce report # noqa: E501
Get breakdown of product activity for an outreach. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_facebook_ad_product_activity_report(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str sort_field: Returns files sorted by the specified field.
:return: InlineResponse2007
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_facebook_ad_product_activity_report_with_http_info(outreach_id, **kwargs) # noqa: E501
else:
(data) = self.get_facebook_ad_product_activity_report_with_http_info(outreach_id, **kwargs) # noqa: E501
return data
|
(self, outreach_id, **kwargs)
|
69,466 |
mailchimp_marketing.api.reporting_api
|
get_facebook_ad_product_activity_report_with_http_info
|
List facebook ecommerce report # noqa: E501
Get breakdown of product activity for an outreach. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_facebook_ad_product_activity_report_with_http_info(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str sort_field: Returns files sorted by the specified field.
:return: InlineResponse2007
If the method is called asynchronously,
returns the request thread.
|
def get_facebook_ad_product_activity_report_with_http_info(self, outreach_id, **kwargs): # noqa: E501
"""List facebook ecommerce report # noqa: E501
Get breakdown of product activity for an outreach. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_facebook_ad_product_activity_report_with_http_info(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str sort_field: Returns files sorted by the specified field.
:return: InlineResponse2007
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['outreach_id', 'fields', 'exclude_fields', 'count', 'offset', 'sort_field'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_facebook_ad_product_activity_report" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'outreach_id' is set
if ('outreach_id' not in params or
params['outreach_id'] is None):
raise ValueError("Missing the required parameter `outreach_id` when calling ``") # noqa: E501
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
if 'outreach_id' in params:
path_params['outreach_id'] = params['outreach_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'sort_field' in params:
query_params.append(('sort_field', params['sort_field'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/facebook-ads/{outreach_id}/ecommerce-product-activity', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse2007', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, outreach_id, **kwargs)
|
69,467 |
mailchimp_marketing.api.reporting_api
|
get_facebook_ad_report
|
Get facebook ad report # noqa: E501
Get report of a Facebook ad. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_facebook_ad_report(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: InlineResponse20011
If the method is called asynchronously,
returns the request thread.
|
def get_facebook_ad_report(self, outreach_id, **kwargs): # noqa: E501
"""Get facebook ad report # noqa: E501
Get report of a Facebook ad. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_facebook_ad_report(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: InlineResponse20011
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_facebook_ad_report_with_http_info(outreach_id, **kwargs) # noqa: E501
else:
(data) = self.get_facebook_ad_report_with_http_info(outreach_id, **kwargs) # noqa: E501
return data
|
(self, outreach_id, **kwargs)
|
69,468 |
mailchimp_marketing.api.reporting_api
|
get_facebook_ad_report_with_http_info
|
Get facebook ad report # noqa: E501
Get report of a Facebook ad. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_facebook_ad_report_with_http_info(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: InlineResponse20011
If the method is called asynchronously,
returns the request thread.
|
def get_facebook_ad_report_with_http_info(self, outreach_id, **kwargs): # noqa: E501
"""Get facebook ad report # noqa: E501
Get report of a Facebook ad. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_facebook_ad_report_with_http_info(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: InlineResponse20011
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['outreach_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_facebook_ad_report" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'outreach_id' is set
if ('outreach_id' not in params or
params['outreach_id'] is None):
raise ValueError("Missing the required parameter `outreach_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'outreach_id' in params:
path_params['outreach_id'] = params['outreach_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/facebook-ads/{outreach_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse20011', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, outreach_id, **kwargs)
|
69,469 |
mailchimp_marketing.api.reporting_api
|
get_facebook_ads_report_all
|
List facebook ads reports # noqa: E501
Get reports of Facebook ads. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_facebook_ads_report_all(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str sort_field: Returns files sorted by the specified field.
:param str sort_dir: Determines the order direction for sorted results.
:return: InlineResponse20010
If the method is called asynchronously,
returns the request thread.
|
def get_facebook_ads_report_all(self, **kwargs): # noqa: E501
"""List facebook ads reports # noqa: E501
Get reports of Facebook ads. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_facebook_ads_report_all(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str sort_field: Returns files sorted by the specified field.
:param str sort_dir: Determines the order direction for sorted results.
:return: InlineResponse20010
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_facebook_ads_report_all_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_facebook_ads_report_all_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
69,470 |
mailchimp_marketing.api.reporting_api
|
get_facebook_ads_report_all_with_http_info
|
List facebook ads reports # noqa: E501
Get reports of Facebook ads. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_facebook_ads_report_all_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str sort_field: Returns files sorted by the specified field.
:param str sort_dir: Determines the order direction for sorted results.
:return: InlineResponse20010
If the method is called asynchronously,
returns the request thread.
|
def get_facebook_ads_report_all_with_http_info(self, **kwargs): # noqa: E501
"""List facebook ads reports # noqa: E501
Get reports of Facebook ads. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_facebook_ads_report_all_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str sort_field: Returns files sorted by the specified field.
:param str sort_dir: Determines the order direction for sorted results.
:return: InlineResponse20010
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['fields', 'exclude_fields', 'count', 'offset', 'sort_field', 'sort_dir'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_facebook_ads_report_all" % key
)
params[key] = val
del params['kwargs']
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'sort_field' in params:
query_params.append(('sort_field', params['sort_field'])) # noqa: E501
if 'sort_dir' in params:
query_params.append(('sort_dir', params['sort_dir'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/facebook-ads', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse20010', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, **kwargs)
|
69,471 |
mailchimp_marketing.api.reporting_api
|
get_landing_page_report
|
Get landing page report # noqa: E501
Get report of a landing page. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_landing_page_report(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: LandingPageReport
If the method is called asynchronously,
returns the request thread.
|
def get_landing_page_report(self, outreach_id, **kwargs): # noqa: E501
"""Get landing page report # noqa: E501
Get report of a landing page. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_landing_page_report(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: LandingPageReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_landing_page_report_with_http_info(outreach_id, **kwargs) # noqa: E501
else:
(data) = self.get_landing_page_report_with_http_info(outreach_id, **kwargs) # noqa: E501
return data
|
(self, outreach_id, **kwargs)
|
69,472 |
mailchimp_marketing.api.reporting_api
|
get_landing_page_report_with_http_info
|
Get landing page report # noqa: E501
Get report of a landing page. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_landing_page_report_with_http_info(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: LandingPageReport
If the method is called asynchronously,
returns the request thread.
|
def get_landing_page_report_with_http_info(self, outreach_id, **kwargs): # noqa: E501
"""Get landing page report # noqa: E501
Get report of a landing page. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_landing_page_report_with_http_info(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: LandingPageReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['outreach_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_landing_page_report" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'outreach_id' is set
if ('outreach_id' not in params or
params['outreach_id'] is None):
raise ValueError("Missing the required parameter `outreach_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'outreach_id' in params:
path_params['outreach_id'] = params['outreach_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/landing-pages/{outreach_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='LandingPageReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, outreach_id, **kwargs)
|
69,473 |
mailchimp_marketing.api.reporting_api
|
get_landing_page_reports_all
|
List landing pages reports # noqa: E501
Get reports of landing pages. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_landing_page_reports_all(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: InlineResponse20012
If the method is called asynchronously,
returns the request thread.
|
def get_landing_page_reports_all(self, **kwargs): # noqa: E501
"""List landing pages reports # noqa: E501
Get reports of landing pages. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_landing_page_reports_all(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: InlineResponse20012
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_landing_page_reports_all_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_landing_page_reports_all_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
69,474 |
mailchimp_marketing.api.reporting_api
|
get_landing_page_reports_all_with_http_info
|
List landing pages reports # noqa: E501
Get reports of landing pages. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_landing_page_reports_all_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: InlineResponse20012
If the method is called asynchronously,
returns the request thread.
|
def get_landing_page_reports_all_with_http_info(self, **kwargs): # noqa: E501
"""List landing pages reports # noqa: E501
Get reports of landing pages. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_landing_page_reports_all_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: InlineResponse20012
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['fields', 'exclude_fields', 'count', 'offset'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_landing_page_reports_all" % key
)
params[key] = val
del params['kwargs']
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/landing-pages', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse20012', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, **kwargs)
|
69,475 |
mailchimp_marketing.api.reporting_api
|
get_survey_question_answers
|
List answers for question # noqa: E501
Get answers for a survey question. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_question_answers(outreach_id, question_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param str question_id: The ID of the survey question. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param str respondent_familiarity_is: Filter survey responses by familiarity of the respondents.
:return: InlineResponse20015
If the method is called asynchronously,
returns the request thread.
|
def get_survey_question_answers(self, outreach_id, question_id, **kwargs): # noqa: E501
"""List answers for question # noqa: E501
Get answers for a survey question. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_question_answers(outreach_id, question_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param str question_id: The ID of the survey question. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param str respondent_familiarity_is: Filter survey responses by familiarity of the respondents.
:return: InlineResponse20015
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_survey_question_answers_with_http_info(outreach_id, question_id, **kwargs) # noqa: E501
else:
(data) = self.get_survey_question_answers_with_http_info(outreach_id, question_id, **kwargs) # noqa: E501
return data
|
(self, outreach_id, question_id, **kwargs)
|
69,476 |
mailchimp_marketing.api.reporting_api
|
get_survey_question_answers_with_http_info
|
List answers for question # noqa: E501
Get answers for a survey question. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_question_answers_with_http_info(outreach_id, question_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param str question_id: The ID of the survey question. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param str respondent_familiarity_is: Filter survey responses by familiarity of the respondents.
:return: InlineResponse20015
If the method is called asynchronously,
returns the request thread.
|
def get_survey_question_answers_with_http_info(self, outreach_id, question_id, **kwargs): # noqa: E501
"""List answers for question # noqa: E501
Get answers for a survey question. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_question_answers_with_http_info(outreach_id, question_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param str question_id: The ID of the survey question. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param str respondent_familiarity_is: Filter survey responses by familiarity of the respondents.
:return: InlineResponse20015
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['outreach_id', 'question_id', 'fields', 'exclude_fields', 'respondent_familiarity_is'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_survey_question_answers" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'outreach_id' is set
if ('outreach_id' not in params or
params['outreach_id'] is None):
raise ValueError("Missing the required parameter `outreach_id` when calling ``") # noqa: E501
# verify the required parameter 'question_id' is set
if ('question_id' not in params or
params['question_id'] is None):
raise ValueError("Missing the required parameter `question_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'outreach_id' in params:
path_params['outreach_id'] = params['outreach_id'] # noqa: E501
if 'question_id' in params:
path_params['question_id'] = params['question_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'respondent_familiarity_is' in params:
query_params.append(('respondent_familiarity_is', params['respondent_familiarity_is'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/surveys/{outreach_id}/questions/{question_id}/answers', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse20015', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, outreach_id, question_id, **kwargs)
|
69,477 |
mailchimp_marketing.api.reporting_api
|
get_survey_question_report
|
Get survey question report # noqa: E501
Get report for a survey question. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_question_report(outreach_id, question_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param str question_id: The ID of the survey question. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: SurveyQuestionReport
If the method is called asynchronously,
returns the request thread.
|
def get_survey_question_report(self, outreach_id, question_id, **kwargs): # noqa: E501
"""Get survey question report # noqa: E501
Get report for a survey question. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_question_report(outreach_id, question_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param str question_id: The ID of the survey question. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: SurveyQuestionReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_survey_question_report_with_http_info(outreach_id, question_id, **kwargs) # noqa: E501
else:
(data) = self.get_survey_question_report_with_http_info(outreach_id, question_id, **kwargs) # noqa: E501
return data
|
(self, outreach_id, question_id, **kwargs)
|
69,478 |
mailchimp_marketing.api.reporting_api
|
get_survey_question_report_with_http_info
|
Get survey question report # noqa: E501
Get report for a survey question. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_question_report_with_http_info(outreach_id, question_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param str question_id: The ID of the survey question. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: SurveyQuestionReport
If the method is called asynchronously,
returns the request thread.
|
def get_survey_question_report_with_http_info(self, outreach_id, question_id, **kwargs): # noqa: E501
"""Get survey question report # noqa: E501
Get report for a survey question. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_question_report_with_http_info(outreach_id, question_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param str question_id: The ID of the survey question. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: SurveyQuestionReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['outreach_id', 'question_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_survey_question_report" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'outreach_id' is set
if ('outreach_id' not in params or
params['outreach_id'] is None):
raise ValueError("Missing the required parameter `outreach_id` when calling ``") # noqa: E501
# verify the required parameter 'question_id' is set
if ('question_id' not in params or
params['question_id'] is None):
raise ValueError("Missing the required parameter `question_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'outreach_id' in params:
path_params['outreach_id'] = params['outreach_id'] # noqa: E501
if 'question_id' in params:
path_params['question_id'] = params['question_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/surveys/{outreach_id}/questions/{question_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SurveyQuestionReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, outreach_id, question_id, **kwargs)
|
69,479 |
mailchimp_marketing.api.reporting_api
|
get_survey_question_reports_all
|
List survey question reports # noqa: E501
Get reports for survey questions. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_question_reports_all(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: InlineResponse20014
If the method is called asynchronously,
returns the request thread.
|
def get_survey_question_reports_all(self, outreach_id, **kwargs): # noqa: E501
"""List survey question reports # noqa: E501
Get reports for survey questions. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_question_reports_all(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: InlineResponse20014
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_survey_question_reports_all_with_http_info(outreach_id, **kwargs) # noqa: E501
else:
(data) = self.get_survey_question_reports_all_with_http_info(outreach_id, **kwargs) # noqa: E501
return data
|
(self, outreach_id, **kwargs)
|
69,480 |
mailchimp_marketing.api.reporting_api
|
get_survey_question_reports_all_with_http_info
|
List survey question reports # noqa: E501
Get reports for survey questions. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_question_reports_all_with_http_info(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: InlineResponse20014
If the method is called asynchronously,
returns the request thread.
|
def get_survey_question_reports_all_with_http_info(self, outreach_id, **kwargs): # noqa: E501
"""List survey question reports # noqa: E501
Get reports for survey questions. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_question_reports_all_with_http_info(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: InlineResponse20014
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['outreach_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_survey_question_reports_all" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'outreach_id' is set
if ('outreach_id' not in params or
params['outreach_id'] is None):
raise ValueError("Missing the required parameter `outreach_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'outreach_id' in params:
path_params['outreach_id'] = params['outreach_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/surveys/{outreach_id}/questions', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse20014', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, outreach_id, **kwargs)
|
69,481 |
mailchimp_marketing.api.reporting_api
|
get_survey_report
|
Get survey report # noqa: E501
Get report for a survey. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_report(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: SurveyReport
If the method is called asynchronously,
returns the request thread.
|
def get_survey_report(self, outreach_id, **kwargs): # noqa: E501
"""Get survey report # noqa: E501
Get report for a survey. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_report(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: SurveyReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_survey_report_with_http_info(outreach_id, **kwargs) # noqa: E501
else:
(data) = self.get_survey_report_with_http_info(outreach_id, **kwargs) # noqa: E501
return data
|
(self, outreach_id, **kwargs)
|
69,482 |
mailchimp_marketing.api.reporting_api
|
get_survey_report_with_http_info
|
Get survey report # noqa: E501
Get report for a survey. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_report_with_http_info(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: SurveyReport
If the method is called asynchronously,
returns the request thread.
|
def get_survey_report_with_http_info(self, outreach_id, **kwargs): # noqa: E501
"""Get survey report # noqa: E501
Get report for a survey. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_report_with_http_info(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: SurveyReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['outreach_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_survey_report" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'outreach_id' is set
if ('outreach_id' not in params or
params['outreach_id'] is None):
raise ValueError("Missing the required parameter `outreach_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'outreach_id' in params:
path_params['outreach_id'] = params['outreach_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/surveys/{outreach_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SurveyReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, outreach_id, **kwargs)
|
69,483 |
mailchimp_marketing.api.reporting_api
|
get_survey_reports_all
|
List survey reports # noqa: E501
Get reports for surveys. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_reports_all(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: InlineResponse20013
If the method is called asynchronously,
returns the request thread.
|
def get_survey_reports_all(self, **kwargs): # noqa: E501
"""List survey reports # noqa: E501
Get reports for surveys. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_reports_all(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: InlineResponse20013
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_survey_reports_all_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_survey_reports_all_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
69,484 |
mailchimp_marketing.api.reporting_api
|
get_survey_reports_all_with_http_info
|
List survey reports # noqa: E501
Get reports for surveys. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_reports_all_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: InlineResponse20013
If the method is called asynchronously,
returns the request thread.
|
def get_survey_reports_all_with_http_info(self, **kwargs): # noqa: E501
"""List survey reports # noqa: E501
Get reports for surveys. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_reports_all_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: InlineResponse20013
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['fields', 'exclude_fields', 'count', 'offset'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_survey_reports_all" % key
)
params[key] = val
del params['kwargs']
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/surveys', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse20013', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, **kwargs)
|
69,485 |
mailchimp_marketing.api.reporting_api
|
get_survey_response
|
Get survey response # noqa: E501
Get a single survey response. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_response(outreach_id, response_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param str response_id: The ID of the survey response. (required)
:return: SurveyResponse
If the method is called asynchronously,
returns the request thread.
|
def get_survey_response(self, outreach_id, response_id, **kwargs): # noqa: E501
"""Get survey response # noqa: E501
Get a single survey response. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_response(outreach_id, response_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param str response_id: The ID of the survey response. (required)
:return: SurveyResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_survey_response_with_http_info(outreach_id, response_id, **kwargs) # noqa: E501
else:
(data) = self.get_survey_response_with_http_info(outreach_id, response_id, **kwargs) # noqa: E501
return data
|
(self, outreach_id, response_id, **kwargs)
|
69,486 |
mailchimp_marketing.api.reporting_api
|
get_survey_response_with_http_info
|
Get survey response # noqa: E501
Get a single survey response. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_response_with_http_info(outreach_id, response_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param str response_id: The ID of the survey response. (required)
:return: SurveyResponse
If the method is called asynchronously,
returns the request thread.
|
def get_survey_response_with_http_info(self, outreach_id, response_id, **kwargs): # noqa: E501
"""Get survey response # noqa: E501
Get a single survey response. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_response_with_http_info(outreach_id, response_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param str response_id: The ID of the survey response. (required)
:return: SurveyResponse
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['outreach_id', 'response_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_survey_response" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'outreach_id' is set
if ('outreach_id' not in params or
params['outreach_id'] is None):
raise ValueError("Missing the required parameter `outreach_id` when calling ``") # noqa: E501
# verify the required parameter 'response_id' is set
if ('response_id' not in params or
params['response_id'] is None):
raise ValueError("Missing the required parameter `response_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'outreach_id' in params:
path_params['outreach_id'] = params['outreach_id'] # noqa: E501
if 'response_id' in params:
path_params['response_id'] = params['response_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/surveys/{outreach_id}/responses/{response_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SurveyResponse', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, outreach_id, response_id, **kwargs)
|
69,487 |
mailchimp_marketing.api.reporting_api
|
get_survey_responses_all
|
List survey responses # noqa: E501
Get responses to a survey. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_responses_all(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int answered_question: The ID of the question that was answered.
:param str chose_answer: The ID of the option chosen to filter responses on.
:param str respondent_familiarity_is: Filter survey responses by familiarity of the respondents.
:return: InlineResponse20016
If the method is called asynchronously,
returns the request thread.
|
def get_survey_responses_all(self, outreach_id, **kwargs): # noqa: E501
"""List survey responses # noqa: E501
Get responses to a survey. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_responses_all(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int answered_question: The ID of the question that was answered.
:param str chose_answer: The ID of the option chosen to filter responses on.
:param str respondent_familiarity_is: Filter survey responses by familiarity of the respondents.
:return: InlineResponse20016
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_survey_responses_all_with_http_info(outreach_id, **kwargs) # noqa: E501
else:
(data) = self.get_survey_responses_all_with_http_info(outreach_id, **kwargs) # noqa: E501
return data
|
(self, outreach_id, **kwargs)
|
69,488 |
mailchimp_marketing.api.reporting_api
|
get_survey_responses_all_with_http_info
|
List survey responses # noqa: E501
Get responses to a survey. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_responses_all_with_http_info(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int answered_question: The ID of the question that was answered.
:param str chose_answer: The ID of the option chosen to filter responses on.
:param str respondent_familiarity_is: Filter survey responses by familiarity of the respondents.
:return: InlineResponse20016
If the method is called asynchronously,
returns the request thread.
|
def get_survey_responses_all_with_http_info(self, outreach_id, **kwargs): # noqa: E501
"""List survey responses # noqa: E501
Get responses to a survey. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_survey_responses_all_with_http_info(outreach_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str outreach_id: The outreach id. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int answered_question: The ID of the question that was answered.
:param str chose_answer: The ID of the option chosen to filter responses on.
:param str respondent_familiarity_is: Filter survey responses by familiarity of the respondents.
:return: InlineResponse20016
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['outreach_id', 'fields', 'exclude_fields', 'answered_question', 'chose_answer', 'respondent_familiarity_is'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_survey_responses_all" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'outreach_id' is set
if ('outreach_id' not in params or
params['outreach_id'] is None):
raise ValueError("Missing the required parameter `outreach_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'outreach_id' in params:
path_params['outreach_id'] = params['outreach_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'answered_question' in params:
query_params.append(('answered_question', params['answered_question'])) # noqa: E501
if 'chose_answer' in params:
query_params.append(('chose_answer', params['chose_answer'])) # noqa: E501
if 'respondent_familiarity_is' in params:
query_params.append(('respondent_familiarity_is', params['respondent_familiarity_is'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reporting/surveys/{outreach_id}/responses', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse20016', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, outreach_id, **kwargs)
|
69,489 |
mailchimp_marketing.api.reports_api
|
ReportsApi
|
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 ReportsApi(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_client):
self.api_client = api_client
def get_all_campaign_reports(self, **kwargs): # noqa: E501
"""List campaign reports # noqa: E501
Get campaign reports. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_campaign_reports(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str type: The campaign type.
:param datetime before_send_time: Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:param datetime since_send_time: Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: CampaignReports1
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_all_campaign_reports_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_all_campaign_reports_with_http_info(**kwargs) # noqa: E501
return data
def get_all_campaign_reports_with_http_info(self, **kwargs): # noqa: E501
"""List campaign reports # noqa: E501
Get campaign reports. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_campaign_reports_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str type: The campaign type.
:param datetime before_send_time: Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:param datetime since_send_time: Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: CampaignReports1
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['fields', 'exclude_fields', 'count', 'offset', 'type', 'before_send_time', 'since_send_time'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_all_campaign_reports" % key
)
params[key] = val
del params['kwargs']
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'type' in params:
query_params.append(('type', params['type'])) # noqa: E501
if 'before_send_time' in params:
query_params.append(('before_send_time', params['before_send_time'])) # noqa: E501
if 'since_send_time' in params:
query_params.append(('since_send_time', params['since_send_time'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CampaignReports1', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_campaign_report(self, campaign_id, **kwargs): # noqa: E501
"""Get campaign report # noqa: E501
Get report details for a specific sent campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_report(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: CampaignReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_campaign_report_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_campaign_report_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
def get_campaign_report_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""Get campaign report # noqa: E501
Get report details for a specific sent campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_report_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: CampaignReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_campaign_report" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CampaignReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_campaign_abuse_reports(self, campaign_id, **kwargs): # noqa: E501
"""List abuse reports # noqa: E501
Get a list of abuse complaints for a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_abuse_reports(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: AbuseComplaints1
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_campaign_abuse_reports_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_campaign_abuse_reports_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
def get_campaign_abuse_reports_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List abuse reports # noqa: E501
Get a list of abuse complaints for a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_abuse_reports_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: AbuseComplaints1
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_campaign_abuse_reports" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/abuse-reports', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='AbuseComplaints1', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_campaign_abuse_report(self, campaign_id, report_id, **kwargs): # noqa: E501
"""Get abuse report # noqa: E501
Get information about a specific abuse report for a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_abuse_report(campaign_id, report_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str report_id: The id for the abuse report. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: AbuseComplaint1
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_campaign_abuse_report_with_http_info(campaign_id, report_id, **kwargs) # noqa: E501
else:
(data) = self.get_campaign_abuse_report_with_http_info(campaign_id, report_id, **kwargs) # noqa: E501
return data
def get_campaign_abuse_report_with_http_info(self, campaign_id, report_id, **kwargs): # noqa: E501
"""Get abuse report # noqa: E501
Get information about a specific abuse report for a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_abuse_report_with_http_info(campaign_id, report_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str report_id: The id for the abuse report. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: AbuseComplaint1
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'report_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_campaign_abuse_report" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
# verify the required parameter 'report_id' is set
if ('report_id' not in params or
params['report_id'] is None):
raise ValueError("Missing the required parameter `report_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
if 'report_id' in params:
path_params['report_id'] = params['report_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/abuse-reports/{report_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='AbuseComplaint1', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_campaign_advice(self, campaign_id, **kwargs): # noqa: E501
"""List campaign feedback # noqa: E501
Get feedback based on a campaign's statistics. Advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_advice(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: CampaignAdviceReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_campaign_advice_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_campaign_advice_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
def get_campaign_advice_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List campaign feedback # noqa: E501
Get feedback based on a campaign's statistics. Advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_advice_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: CampaignAdviceReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_campaign_advice" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/advice', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CampaignAdviceReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_campaign_click_details(self, campaign_id, **kwargs): # noqa: E501
"""List campaign details # noqa: E501
Get information about clicks on specific links in your Mailchimp campaigns. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_click_details(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: ClickDetailReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_campaign_click_details_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_campaign_click_details_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
def get_campaign_click_details_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List campaign details # noqa: E501
Get information about clicks on specific links in your Mailchimp campaigns. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_click_details_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: ClickDetailReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields', 'count', 'offset'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_campaign_click_details" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/click-details', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ClickDetailReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_campaign_click_details_for_link(self, campaign_id, link_id, **kwargs): # noqa: E501
"""Get campaign link details # noqa: E501
Get click details for a specific link in a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_click_details_for_link(campaign_id, link_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str link_id: The id for the link. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: ClickDetailReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_campaign_click_details_for_link_with_http_info(campaign_id, link_id, **kwargs) # noqa: E501
else:
(data) = self.get_campaign_click_details_for_link_with_http_info(campaign_id, link_id, **kwargs) # noqa: E501
return data
def get_campaign_click_details_for_link_with_http_info(self, campaign_id, link_id, **kwargs): # noqa: E501
"""Get campaign link details # noqa: E501
Get click details for a specific link in a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_click_details_for_link_with_http_info(campaign_id, link_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str link_id: The id for the link. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: ClickDetailReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'link_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_campaign_click_details_for_link" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
# verify the required parameter 'link_id' is set
if ('link_id' not in params or
params['link_id'] is None):
raise ValueError("Missing the required parameter `link_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
if 'link_id' in params:
path_params['link_id'] = params['link_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/click-details/{link_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ClickDetailReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_subscribers_info(self, campaign_id, link_id, **kwargs): # noqa: E501
"""List clicked link subscribers # noqa: E501
Get information about list members who clicked on a specific link in a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_subscribers_info(campaign_id, link_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str link_id: The id for the link. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: ClickDetailMembers
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_subscribers_info_with_http_info(campaign_id, link_id, **kwargs) # noqa: E501
else:
(data) = self.get_subscribers_info_with_http_info(campaign_id, link_id, **kwargs) # noqa: E501
return data
def get_subscribers_info_with_http_info(self, campaign_id, link_id, **kwargs): # noqa: E501
"""List clicked link subscribers # noqa: E501
Get information about list members who clicked on a specific link in a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_subscribers_info_with_http_info(campaign_id, link_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str link_id: The id for the link. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: ClickDetailMembers
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'link_id', 'fields', 'exclude_fields', 'count', 'offset'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_subscribers_info" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
# verify the required parameter 'link_id' is set
if ('link_id' not in params or
params['link_id'] is None):
raise ValueError("Missing the required parameter `link_id` when calling ``") # noqa: E501
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
if 'link_id' in params:
path_params['link_id'] = params['link_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/click-details/{link_id}/members', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ClickDetailMembers', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_subscriber_info(self, campaign_id, link_id, subscriber_hash, **kwargs): # noqa: E501
"""Get clicked link subscriber # noqa: E501
Get information about a specific subscriber who clicked a link in a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_subscriber_info(campaign_id, link_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str link_id: The id for the link. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: ClickDetailMember
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_subscriber_info_with_http_info(campaign_id, link_id, subscriber_hash, **kwargs) # noqa: E501
else:
(data) = self.get_subscriber_info_with_http_info(campaign_id, link_id, subscriber_hash, **kwargs) # noqa: E501
return data
def get_subscriber_info_with_http_info(self, campaign_id, link_id, subscriber_hash, **kwargs): # noqa: E501
"""Get clicked link subscriber # noqa: E501
Get information about a specific subscriber who clicked a link in a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_subscriber_info_with_http_info(campaign_id, link_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str link_id: The id for the link. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: ClickDetailMember
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'link_id', 'subscriber_hash', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_subscriber_info" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
# verify the required parameter 'link_id' is set
if ('link_id' not in params or
params['link_id'] is None):
raise ValueError("Missing the required parameter `link_id` when calling ``") # noqa: E501
# verify the required parameter 'subscriber_hash' is set
if ('subscriber_hash' not in params or
params['subscriber_hash'] is None):
raise ValueError("Missing the required parameter `subscriber_hash` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
if 'link_id' in params:
path_params['link_id'] = params['link_id'] # noqa: E501
if 'subscriber_hash' in params:
path_params['subscriber_hash'] = params['subscriber_hash'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ClickDetailMember', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_domain_performance_for_campaign(self, campaign_id, **kwargs): # noqa: E501
"""List domain performance stats # noqa: E501
Get statistics for the top-performing email domains in a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_domain_performance_for_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: DomainPerformance
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_domain_performance_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_domain_performance_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
def get_domain_performance_for_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List domain performance stats # noqa: E501
Get statistics for the top-performing email domains in a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_domain_performance_for_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: DomainPerformance
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_domain_performance_for_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/domain-performance', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DomainPerformance', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_ecommerce_product_activity_for_campaign(self, campaign_id, **kwargs): # noqa: E501
"""List campaign product activity # noqa: E501
Get breakdown of product activity for a campaign # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_ecommerce_product_activity_for_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str sort_field: Returns files sorted by the specified field.
:return: InlineResponse2007
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_ecommerce_product_activity_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_ecommerce_product_activity_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
def get_ecommerce_product_activity_for_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List campaign product activity # noqa: E501
Get breakdown of product activity for a campaign # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_ecommerce_product_activity_for_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str sort_field: Returns files sorted by the specified field.
:return: InlineResponse2007
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields', 'count', 'offset', 'sort_field'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_ecommerce_product_activity_for_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'sort_field' in params:
query_params.append(('sort_field', params['sort_field'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/ecommerce-product-activity', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse2007', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_eepurl_activity_for_campaign(self, campaign_id, **kwargs): # noqa: E501
"""List EepURL activity # noqa: E501
Get a summary of social activity for the campaign, tracked by EepURL. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_eepurl_activity_for_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: EepurlActivity
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_eepurl_activity_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_eepurl_activity_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
def get_eepurl_activity_for_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List EepURL activity # noqa: E501
Get a summary of social activity for the campaign, tracked by EepURL. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_eepurl_activity_for_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: EepurlActivity
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_eepurl_activity_for_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/eepurl', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='EepurlActivity', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_email_activity_for_campaign(self, campaign_id, **kwargs): # noqa: E501
"""List email activity # noqa: E501
Get a list of member's subscriber activity in a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_activity_for_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str since: Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: EmailActivity
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_email_activity_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_email_activity_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
def get_email_activity_for_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List email activity # noqa: E501
Get a list of member's subscriber activity in a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_activity_for_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str since: Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: EmailActivity
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields', 'count', 'offset', 'since'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_email_activity_for_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'since' in params:
query_params.append(('since', params['since'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/email-activity', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='EmailActivity', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_email_activity_for_subscriber(self, campaign_id, subscriber_hash, **kwargs): # noqa: E501
"""Get subscriber email activity # noqa: E501
Get a specific list member's activity in a campaign including opens, clicks, and bounces. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_activity_for_subscriber(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param str since: Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: EmailActivity
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_email_activity_for_subscriber_with_http_info(campaign_id, subscriber_hash, **kwargs) # noqa: E501
else:
(data) = self.get_email_activity_for_subscriber_with_http_info(campaign_id, subscriber_hash, **kwargs) # noqa: E501
return data
def get_email_activity_for_subscriber_with_http_info(self, campaign_id, subscriber_hash, **kwargs): # noqa: E501
"""Get subscriber email activity # noqa: E501
Get a specific list member's activity in a campaign including opens, clicks, and bounces. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_activity_for_subscriber_with_http_info(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param str since: Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: EmailActivity
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'subscriber_hash', 'fields', 'exclude_fields', 'since'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_email_activity_for_subscriber" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
# verify the required parameter 'subscriber_hash' is set
if ('subscriber_hash' not in params or
params['subscriber_hash'] is None):
raise ValueError("Missing the required parameter `subscriber_hash` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
if 'subscriber_hash' in params:
path_params['subscriber_hash'] = params['subscriber_hash'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'since' in params:
query_params.append(('since', params['since'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/email-activity/{subscriber_hash}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='EmailActivity', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_locations_for_campaign(self, campaign_id, **kwargs): # noqa: E501
"""List top open activities # noqa: E501
Get top open locations for a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_locations_for_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: OpenLocations
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_locations_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_locations_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
def get_locations_for_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List top open activities # noqa: E501
Get top open locations for a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_locations_for_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: OpenLocations
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields', 'count', 'offset'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_locations_for_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/locations', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='OpenLocations', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_campaign_open_details(self, campaign_id, **kwargs): # noqa: E501
"""List campaign open details # noqa: E501
Get detailed information about any campaign emails that were opened by a list member. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_open_details(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str since: Restrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: OpenDetailReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_campaign_open_details_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_campaign_open_details_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
def get_campaign_open_details_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List campaign open details # noqa: E501
Get detailed information about any campaign emails that were opened by a list member. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_open_details_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str since: Restrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: OpenDetailReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields', 'count', 'offset', 'since'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_campaign_open_details" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'since' in params:
query_params.append(('since', params['since'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/open-details', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='OpenDetailReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_subscriber_info_for_opened_campaign(self, campaign_id, subscriber_hash, **kwargs): # noqa: E501
"""Get opened campaign subscriber # noqa: E501
Get information about a specific subscriber who opened a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_subscriber_info_for_opened_campaign(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: OpenActivity
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_subscriber_info_for_opened_campaign_with_http_info(campaign_id, subscriber_hash, **kwargs) # noqa: E501
else:
(data) = self.get_subscriber_info_for_opened_campaign_with_http_info(campaign_id, subscriber_hash, **kwargs) # noqa: E501
return data
def get_subscriber_info_for_opened_campaign_with_http_info(self, campaign_id, subscriber_hash, **kwargs): # noqa: E501
"""Get opened campaign subscriber # noqa: E501
Get information about a specific subscriber who opened a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_subscriber_info_for_opened_campaign_with_http_info(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: OpenActivity
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'subscriber_hash', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_subscriber_info_for_opened_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
# verify the required parameter 'subscriber_hash' is set
if ('subscriber_hash' not in params or
params['subscriber_hash'] is None):
raise ValueError("Missing the required parameter `subscriber_hash` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
if 'subscriber_hash' in params:
path_params['subscriber_hash'] = params['subscriber_hash'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/open-details/{subscriber_hash}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='OpenActivity', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_campaign_recipients(self, campaign_id, **kwargs): # noqa: E501
"""List campaign recipients # noqa: E501
Get information about campaign recipients. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_recipients(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: SentTo
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_campaign_recipients_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_campaign_recipients_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
def get_campaign_recipients_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List campaign recipients # noqa: E501
Get information about campaign recipients. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_recipients_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: SentTo
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields', 'count', 'offset'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_campaign_recipients" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/sent-to', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SentTo', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_campaign_recipient(self, campaign_id, subscriber_hash, **kwargs): # noqa: E501
"""Get campaign recipient info # noqa: E501
Get information about a specific campaign recipient. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_recipient(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: SentTo
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_campaign_recipient_with_http_info(campaign_id, subscriber_hash, **kwargs) # noqa: E501
else:
(data) = self.get_campaign_recipient_with_http_info(campaign_id, subscriber_hash, **kwargs) # noqa: E501
return data
def get_campaign_recipient_with_http_info(self, campaign_id, subscriber_hash, **kwargs): # noqa: E501
"""Get campaign recipient info # noqa: E501
Get information about a specific campaign recipient. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_recipient_with_http_info(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: SentTo
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'subscriber_hash', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_campaign_recipient" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
# verify the required parameter 'subscriber_hash' is set
if ('subscriber_hash' not in params or
params['subscriber_hash'] is None):
raise ValueError("Missing the required parameter `subscriber_hash` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
if 'subscriber_hash' in params:
path_params['subscriber_hash'] = params['subscriber_hash'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/sent-to/{subscriber_hash}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SentTo', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_sub_reports_for_campaign(self, campaign_id, **kwargs): # noqa: E501
"""List child campaign reports # noqa: E501
Get a list of reports with child campaigns for a specific parent campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_sub_reports_for_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: CampaignSubReports
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_sub_reports_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_sub_reports_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
def get_sub_reports_for_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List child campaign reports # noqa: E501
Get a list of reports with child campaigns for a specific parent campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_sub_reports_for_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: CampaignSubReports
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_sub_reports_for_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/sub-reports', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CampaignSubReports', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_unsubscribed_list_for_campaign(self, campaign_id, **kwargs): # noqa: E501
"""List unsubscribed members # noqa: E501
Get information about members who have unsubscribed from a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_unsubscribed_list_for_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: Unsubscribes
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_unsubscribed_list_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_unsubscribed_list_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
def get_unsubscribed_list_for_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List unsubscribed members # noqa: E501
Get information about members who have unsubscribed from a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_unsubscribed_list_for_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: Unsubscribes
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields', 'count', 'offset'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_unsubscribed_list_for_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/unsubscribed', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Unsubscribes', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def get_unsubscribed_list_member(self, campaign_id, subscriber_hash, **kwargs): # noqa: E501
"""Get unsubscribed member # noqa: E501
Get information about a specific list member who unsubscribed from a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_unsubscribed_list_member(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: Unsubscribes
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_unsubscribed_list_member_with_http_info(campaign_id, subscriber_hash, **kwargs) # noqa: E501
else:
(data) = self.get_unsubscribed_list_member_with_http_info(campaign_id, subscriber_hash, **kwargs) # noqa: E501
return data
def get_unsubscribed_list_member_with_http_info(self, campaign_id, subscriber_hash, **kwargs): # noqa: E501
"""Get unsubscribed member # noqa: E501
Get information about a specific list member who unsubscribed from a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_unsubscribed_list_member_with_http_info(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: Unsubscribes
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'subscriber_hash', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_unsubscribed_list_member" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
# verify the required parameter 'subscriber_hash' is set
if ('subscriber_hash' not in params or
params['subscriber_hash'] is None):
raise ValueError("Missing the required parameter `subscriber_hash` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
if 'subscriber_hash' in params:
path_params['subscriber_hash'] = params['subscriber_hash'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/unsubscribed/{subscriber_hash}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Unsubscribes', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(api_client)
|
69,491 |
mailchimp_marketing.api.reports_api
|
get_all_campaign_reports
|
List campaign reports # noqa: E501
Get campaign reports. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_campaign_reports(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str type: The campaign type.
:param datetime before_send_time: Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:param datetime since_send_time: Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: CampaignReports1
If the method is called asynchronously,
returns the request thread.
|
def get_all_campaign_reports(self, **kwargs): # noqa: E501
"""List campaign reports # noqa: E501
Get campaign reports. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_campaign_reports(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str type: The campaign type.
:param datetime before_send_time: Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:param datetime since_send_time: Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: CampaignReports1
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_all_campaign_reports_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_all_campaign_reports_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
69,492 |
mailchimp_marketing.api.reports_api
|
get_all_campaign_reports_with_http_info
|
List campaign reports # noqa: E501
Get campaign reports. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_campaign_reports_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str type: The campaign type.
:param datetime before_send_time: Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:param datetime since_send_time: Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: CampaignReports1
If the method is called asynchronously,
returns the request thread.
|
def get_all_campaign_reports_with_http_info(self, **kwargs): # noqa: E501
"""List campaign reports # noqa: E501
Get campaign reports. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_campaign_reports_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str type: The campaign type.
:param datetime before_send_time: Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:param datetime since_send_time: Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: CampaignReports1
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['fields', 'exclude_fields', 'count', 'offset', 'type', 'before_send_time', 'since_send_time'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_all_campaign_reports" % key
)
params[key] = val
del params['kwargs']
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'type' in params:
query_params.append(('type', params['type'])) # noqa: E501
if 'before_send_time' in params:
query_params.append(('before_send_time', params['before_send_time'])) # noqa: E501
if 'since_send_time' in params:
query_params.append(('since_send_time', params['since_send_time'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CampaignReports1', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, **kwargs)
|
69,493 |
mailchimp_marketing.api.reports_api
|
get_campaign_abuse_report
|
Get abuse report # noqa: E501
Get information about a specific abuse report for a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_abuse_report(campaign_id, report_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str report_id: The id for the abuse report. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: AbuseComplaint1
If the method is called asynchronously,
returns the request thread.
|
def get_campaign_abuse_report(self, campaign_id, report_id, **kwargs): # noqa: E501
"""Get abuse report # noqa: E501
Get information about a specific abuse report for a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_abuse_report(campaign_id, report_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str report_id: The id for the abuse report. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: AbuseComplaint1
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_campaign_abuse_report_with_http_info(campaign_id, report_id, **kwargs) # noqa: E501
else:
(data) = self.get_campaign_abuse_report_with_http_info(campaign_id, report_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, report_id, **kwargs)
|
69,494 |
mailchimp_marketing.api.reports_api
|
get_campaign_abuse_report_with_http_info
|
Get abuse report # noqa: E501
Get information about a specific abuse report for a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_abuse_report_with_http_info(campaign_id, report_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str report_id: The id for the abuse report. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: AbuseComplaint1
If the method is called asynchronously,
returns the request thread.
|
def get_campaign_abuse_report_with_http_info(self, campaign_id, report_id, **kwargs): # noqa: E501
"""Get abuse report # noqa: E501
Get information about a specific abuse report for a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_abuse_report_with_http_info(campaign_id, report_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str report_id: The id for the abuse report. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: AbuseComplaint1
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'report_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_campaign_abuse_report" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
# verify the required parameter 'report_id' is set
if ('report_id' not in params or
params['report_id'] is None):
raise ValueError("Missing the required parameter `report_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
if 'report_id' in params:
path_params['report_id'] = params['report_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/abuse-reports/{report_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='AbuseComplaint1', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, report_id, **kwargs)
|
69,495 |
mailchimp_marketing.api.reports_api
|
get_campaign_abuse_reports
|
List abuse reports # noqa: E501
Get a list of abuse complaints for a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_abuse_reports(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: AbuseComplaints1
If the method is called asynchronously,
returns the request thread.
|
def get_campaign_abuse_reports(self, campaign_id, **kwargs): # noqa: E501
"""List abuse reports # noqa: E501
Get a list of abuse complaints for a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_abuse_reports(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: AbuseComplaints1
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_campaign_abuse_reports_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_campaign_abuse_reports_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, **kwargs)
|
69,496 |
mailchimp_marketing.api.reports_api
|
get_campaign_abuse_reports_with_http_info
|
List abuse reports # noqa: E501
Get a list of abuse complaints for a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_abuse_reports_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: AbuseComplaints1
If the method is called asynchronously,
returns the request thread.
|
def get_campaign_abuse_reports_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List abuse reports # noqa: E501
Get a list of abuse complaints for a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_abuse_reports_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: AbuseComplaints1
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_campaign_abuse_reports" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/abuse-reports', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='AbuseComplaints1', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, **kwargs)
|
69,497 |
mailchimp_marketing.api.reports_api
|
get_campaign_advice
|
List campaign feedback # noqa: E501
Get feedback based on a campaign's statistics. Advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_advice(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: CampaignAdviceReport
If the method is called asynchronously,
returns the request thread.
|
def get_campaign_advice(self, campaign_id, **kwargs): # noqa: E501
"""List campaign feedback # noqa: E501
Get feedback based on a campaign's statistics. Advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_advice(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: CampaignAdviceReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_campaign_advice_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_campaign_advice_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, **kwargs)
|
69,498 |
mailchimp_marketing.api.reports_api
|
get_campaign_advice_with_http_info
|
List campaign feedback # noqa: E501
Get feedback based on a campaign's statistics. Advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_advice_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: CampaignAdviceReport
If the method is called asynchronously,
returns the request thread.
|
def get_campaign_advice_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List campaign feedback # noqa: E501
Get feedback based on a campaign's statistics. Advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_advice_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: CampaignAdviceReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_campaign_advice" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/advice', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CampaignAdviceReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, **kwargs)
|
69,499 |
mailchimp_marketing.api.reports_api
|
get_campaign_click_details
|
List campaign details # noqa: E501
Get information about clicks on specific links in your Mailchimp campaigns. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_click_details(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: ClickDetailReport
If the method is called asynchronously,
returns the request thread.
|
def get_campaign_click_details(self, campaign_id, **kwargs): # noqa: E501
"""List campaign details # noqa: E501
Get information about clicks on specific links in your Mailchimp campaigns. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_click_details(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: ClickDetailReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_campaign_click_details_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_campaign_click_details_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, **kwargs)
|
69,500 |
mailchimp_marketing.api.reports_api
|
get_campaign_click_details_for_link
|
Get campaign link details # noqa: E501
Get click details for a specific link in a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_click_details_for_link(campaign_id, link_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str link_id: The id for the link. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: ClickDetailReport
If the method is called asynchronously,
returns the request thread.
|
def get_campaign_click_details_for_link(self, campaign_id, link_id, **kwargs): # noqa: E501
"""Get campaign link details # noqa: E501
Get click details for a specific link in a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_click_details_for_link(campaign_id, link_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str link_id: The id for the link. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: ClickDetailReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_campaign_click_details_for_link_with_http_info(campaign_id, link_id, **kwargs) # noqa: E501
else:
(data) = self.get_campaign_click_details_for_link_with_http_info(campaign_id, link_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, link_id, **kwargs)
|
69,501 |
mailchimp_marketing.api.reports_api
|
get_campaign_click_details_for_link_with_http_info
|
Get campaign link details # noqa: E501
Get click details for a specific link in a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_click_details_for_link_with_http_info(campaign_id, link_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str link_id: The id for the link. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: ClickDetailReport
If the method is called asynchronously,
returns the request thread.
|
def get_campaign_click_details_for_link_with_http_info(self, campaign_id, link_id, **kwargs): # noqa: E501
"""Get campaign link details # noqa: E501
Get click details for a specific link in a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_click_details_for_link_with_http_info(campaign_id, link_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str link_id: The id for the link. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: ClickDetailReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'link_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_campaign_click_details_for_link" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
# verify the required parameter 'link_id' is set
if ('link_id' not in params or
params['link_id'] is None):
raise ValueError("Missing the required parameter `link_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
if 'link_id' in params:
path_params['link_id'] = params['link_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/click-details/{link_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ClickDetailReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, link_id, **kwargs)
|
69,502 |
mailchimp_marketing.api.reports_api
|
get_campaign_click_details_with_http_info
|
List campaign details # noqa: E501
Get information about clicks on specific links in your Mailchimp campaigns. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_click_details_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: ClickDetailReport
If the method is called asynchronously,
returns the request thread.
|
def get_campaign_click_details_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List campaign details # noqa: E501
Get information about clicks on specific links in your Mailchimp campaigns. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_click_details_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: ClickDetailReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields', 'count', 'offset'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_campaign_click_details" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/click-details', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ClickDetailReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, **kwargs)
|
69,503 |
mailchimp_marketing.api.reports_api
|
get_campaign_open_details
|
List campaign open details # noqa: E501
Get detailed information about any campaign emails that were opened by a list member. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_open_details(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str since: Restrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: OpenDetailReport
If the method is called asynchronously,
returns the request thread.
|
def get_campaign_open_details(self, campaign_id, **kwargs): # noqa: E501
"""List campaign open details # noqa: E501
Get detailed information about any campaign emails that were opened by a list member. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_open_details(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str since: Restrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: OpenDetailReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_campaign_open_details_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_campaign_open_details_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, **kwargs)
|
69,504 |
mailchimp_marketing.api.reports_api
|
get_campaign_open_details_with_http_info
|
List campaign open details # noqa: E501
Get detailed information about any campaign emails that were opened by a list member. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_open_details_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str since: Restrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: OpenDetailReport
If the method is called asynchronously,
returns the request thread.
|
def get_campaign_open_details_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List campaign open details # noqa: E501
Get detailed information about any campaign emails that were opened by a list member. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_open_details_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str since: Restrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: OpenDetailReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields', 'count', 'offset', 'since'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_campaign_open_details" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'since' in params:
query_params.append(('since', params['since'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/open-details', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='OpenDetailReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, **kwargs)
|
69,505 |
mailchimp_marketing.api.reports_api
|
get_campaign_recipient
|
Get campaign recipient info # noqa: E501
Get information about a specific campaign recipient. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_recipient(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: SentTo
If the method is called asynchronously,
returns the request thread.
|
def get_campaign_recipient(self, campaign_id, subscriber_hash, **kwargs): # noqa: E501
"""Get campaign recipient info # noqa: E501
Get information about a specific campaign recipient. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_recipient(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: SentTo
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_campaign_recipient_with_http_info(campaign_id, subscriber_hash, **kwargs) # noqa: E501
else:
(data) = self.get_campaign_recipient_with_http_info(campaign_id, subscriber_hash, **kwargs) # noqa: E501
return data
|
(self, campaign_id, subscriber_hash, **kwargs)
|
69,506 |
mailchimp_marketing.api.reports_api
|
get_campaign_recipient_with_http_info
|
Get campaign recipient info # noqa: E501
Get information about a specific campaign recipient. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_recipient_with_http_info(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: SentTo
If the method is called asynchronously,
returns the request thread.
|
def get_campaign_recipient_with_http_info(self, campaign_id, subscriber_hash, **kwargs): # noqa: E501
"""Get campaign recipient info # noqa: E501
Get information about a specific campaign recipient. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_recipient_with_http_info(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: SentTo
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'subscriber_hash', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_campaign_recipient" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
# verify the required parameter 'subscriber_hash' is set
if ('subscriber_hash' not in params or
params['subscriber_hash'] is None):
raise ValueError("Missing the required parameter `subscriber_hash` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
if 'subscriber_hash' in params:
path_params['subscriber_hash'] = params['subscriber_hash'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/sent-to/{subscriber_hash}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SentTo', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, subscriber_hash, **kwargs)
|
69,507 |
mailchimp_marketing.api.reports_api
|
get_campaign_recipients
|
List campaign recipients # noqa: E501
Get information about campaign recipients. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_recipients(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: SentTo
If the method is called asynchronously,
returns the request thread.
|
def get_campaign_recipients(self, campaign_id, **kwargs): # noqa: E501
"""List campaign recipients # noqa: E501
Get information about campaign recipients. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_recipients(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: SentTo
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_campaign_recipients_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_campaign_recipients_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, **kwargs)
|
69,508 |
mailchimp_marketing.api.reports_api
|
get_campaign_recipients_with_http_info
|
List campaign recipients # noqa: E501
Get information about campaign recipients. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_recipients_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: SentTo
If the method is called asynchronously,
returns the request thread.
|
def get_campaign_recipients_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List campaign recipients # noqa: E501
Get information about campaign recipients. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_recipients_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: SentTo
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields', 'count', 'offset'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_campaign_recipients" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/sent-to', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SentTo', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, **kwargs)
|
69,509 |
mailchimp_marketing.api.reports_api
|
get_campaign_report
|
Get campaign report # noqa: E501
Get report details for a specific sent campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_report(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: CampaignReport
If the method is called asynchronously,
returns the request thread.
|
def get_campaign_report(self, campaign_id, **kwargs): # noqa: E501
"""Get campaign report # noqa: E501
Get report details for a specific sent campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_report(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: CampaignReport
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_campaign_report_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_campaign_report_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, **kwargs)
|
69,510 |
mailchimp_marketing.api.reports_api
|
get_campaign_report_with_http_info
|
Get campaign report # noqa: E501
Get report details for a specific sent campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_report_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: CampaignReport
If the method is called asynchronously,
returns the request thread.
|
def get_campaign_report_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""Get campaign report # noqa: E501
Get report details for a specific sent campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_campaign_report_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: CampaignReport
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_campaign_report" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CampaignReport', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, **kwargs)
|
69,511 |
mailchimp_marketing.api.reports_api
|
get_domain_performance_for_campaign
|
List domain performance stats # noqa: E501
Get statistics for the top-performing email domains in a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_domain_performance_for_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: DomainPerformance
If the method is called asynchronously,
returns the request thread.
|
def get_domain_performance_for_campaign(self, campaign_id, **kwargs): # noqa: E501
"""List domain performance stats # noqa: E501
Get statistics for the top-performing email domains in a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_domain_performance_for_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: DomainPerformance
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_domain_performance_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_domain_performance_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, **kwargs)
|
69,512 |
mailchimp_marketing.api.reports_api
|
get_domain_performance_for_campaign_with_http_info
|
List domain performance stats # noqa: E501
Get statistics for the top-performing email domains in a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_domain_performance_for_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: DomainPerformance
If the method is called asynchronously,
returns the request thread.
|
def get_domain_performance_for_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List domain performance stats # noqa: E501
Get statistics for the top-performing email domains in a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_domain_performance_for_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: DomainPerformance
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_domain_performance_for_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/domain-performance', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DomainPerformance', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, **kwargs)
|
69,513 |
mailchimp_marketing.api.reports_api
|
get_ecommerce_product_activity_for_campaign
|
List campaign product activity # noqa: E501
Get breakdown of product activity for a campaign # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_ecommerce_product_activity_for_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str sort_field: Returns files sorted by the specified field.
:return: InlineResponse2007
If the method is called asynchronously,
returns the request thread.
|
def get_ecommerce_product_activity_for_campaign(self, campaign_id, **kwargs): # noqa: E501
"""List campaign product activity # noqa: E501
Get breakdown of product activity for a campaign # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_ecommerce_product_activity_for_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str sort_field: Returns files sorted by the specified field.
:return: InlineResponse2007
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_ecommerce_product_activity_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_ecommerce_product_activity_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, **kwargs)
|
69,514 |
mailchimp_marketing.api.reports_api
|
get_ecommerce_product_activity_for_campaign_with_http_info
|
List campaign product activity # noqa: E501
Get breakdown of product activity for a campaign # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_ecommerce_product_activity_for_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str sort_field: Returns files sorted by the specified field.
:return: InlineResponse2007
If the method is called asynchronously,
returns the request thread.
|
def get_ecommerce_product_activity_for_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List campaign product activity # noqa: E501
Get breakdown of product activity for a campaign # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_ecommerce_product_activity_for_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str sort_field: Returns files sorted by the specified field.
:return: InlineResponse2007
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields', 'count', 'offset', 'sort_field'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_ecommerce_product_activity_for_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'sort_field' in params:
query_params.append(('sort_field', params['sort_field'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/ecommerce-product-activity', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse2007', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, **kwargs)
|
69,515 |
mailchimp_marketing.api.reports_api
|
get_eepurl_activity_for_campaign
|
List EepURL activity # noqa: E501
Get a summary of social activity for the campaign, tracked by EepURL. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_eepurl_activity_for_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: EepurlActivity
If the method is called asynchronously,
returns the request thread.
|
def get_eepurl_activity_for_campaign(self, campaign_id, **kwargs): # noqa: E501
"""List EepURL activity # noqa: E501
Get a summary of social activity for the campaign, tracked by EepURL. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_eepurl_activity_for_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: EepurlActivity
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_eepurl_activity_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_eepurl_activity_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, **kwargs)
|
69,516 |
mailchimp_marketing.api.reports_api
|
get_eepurl_activity_for_campaign_with_http_info
|
List EepURL activity # noqa: E501
Get a summary of social activity for the campaign, tracked by EepURL. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_eepurl_activity_for_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: EepurlActivity
If the method is called asynchronously,
returns the request thread.
|
def get_eepurl_activity_for_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List EepURL activity # noqa: E501
Get a summary of social activity for the campaign, tracked by EepURL. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_eepurl_activity_for_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: EepurlActivity
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_eepurl_activity_for_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/eepurl', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='EepurlActivity', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, **kwargs)
|
69,517 |
mailchimp_marketing.api.reports_api
|
get_email_activity_for_campaign
|
List email activity # noqa: E501
Get a list of member's subscriber activity in a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_activity_for_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str since: Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: EmailActivity
If the method is called asynchronously,
returns the request thread.
|
def get_email_activity_for_campaign(self, campaign_id, **kwargs): # noqa: E501
"""List email activity # noqa: E501
Get a list of member's subscriber activity in a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_activity_for_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str since: Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: EmailActivity
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_email_activity_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_email_activity_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, **kwargs)
|
69,518 |
mailchimp_marketing.api.reports_api
|
get_email_activity_for_campaign_with_http_info
|
List email activity # noqa: E501
Get a list of member's subscriber activity in a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_activity_for_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str since: Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: EmailActivity
If the method is called asynchronously,
returns the request thread.
|
def get_email_activity_for_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List email activity # noqa: E501
Get a list of member's subscriber activity in a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_activity_for_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:param str since: Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: EmailActivity
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields', 'count', 'offset', 'since'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_email_activity_for_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
if 'since' in params:
query_params.append(('since', params['since'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/email-activity', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='EmailActivity', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, **kwargs)
|
69,519 |
mailchimp_marketing.api.reports_api
|
get_email_activity_for_subscriber
|
Get subscriber email activity # noqa: E501
Get a specific list member's activity in a campaign including opens, clicks, and bounces. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_activity_for_subscriber(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param str since: Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: EmailActivity
If the method is called asynchronously,
returns the request thread.
|
def get_email_activity_for_subscriber(self, campaign_id, subscriber_hash, **kwargs): # noqa: E501
"""Get subscriber email activity # noqa: E501
Get a specific list member's activity in a campaign including opens, clicks, and bounces. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_activity_for_subscriber(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param str since: Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: EmailActivity
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_email_activity_for_subscriber_with_http_info(campaign_id, subscriber_hash, **kwargs) # noqa: E501
else:
(data) = self.get_email_activity_for_subscriber_with_http_info(campaign_id, subscriber_hash, **kwargs) # noqa: E501
return data
|
(self, campaign_id, subscriber_hash, **kwargs)
|
69,520 |
mailchimp_marketing.api.reports_api
|
get_email_activity_for_subscriber_with_http_info
|
Get subscriber email activity # noqa: E501
Get a specific list member's activity in a campaign including opens, clicks, and bounces. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_activity_for_subscriber_with_http_info(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param str since: Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: EmailActivity
If the method is called asynchronously,
returns the request thread.
|
def get_email_activity_for_subscriber_with_http_info(self, campaign_id, subscriber_hash, **kwargs): # noqa: E501
"""Get subscriber email activity # noqa: E501
Get a specific list member's activity in a campaign including opens, clicks, and bounces. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_email_activity_for_subscriber_with_http_info(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param str since: Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
:return: EmailActivity
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'subscriber_hash', 'fields', 'exclude_fields', 'since'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_email_activity_for_subscriber" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
# verify the required parameter 'subscriber_hash' is set
if ('subscriber_hash' not in params or
params['subscriber_hash'] is None):
raise ValueError("Missing the required parameter `subscriber_hash` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
if 'subscriber_hash' in params:
path_params['subscriber_hash'] = params['subscriber_hash'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'since' in params:
query_params.append(('since', params['since'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/email-activity/{subscriber_hash}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='EmailActivity', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, subscriber_hash, **kwargs)
|
69,521 |
mailchimp_marketing.api.reports_api
|
get_locations_for_campaign
|
List top open activities # noqa: E501
Get top open locations for a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_locations_for_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: OpenLocations
If the method is called asynchronously,
returns the request thread.
|
def get_locations_for_campaign(self, campaign_id, **kwargs): # noqa: E501
"""List top open activities # noqa: E501
Get top open locations for a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_locations_for_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: OpenLocations
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_locations_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_locations_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, **kwargs)
|
69,522 |
mailchimp_marketing.api.reports_api
|
get_locations_for_campaign_with_http_info
|
List top open activities # noqa: E501
Get top open locations for a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_locations_for_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: OpenLocations
If the method is called asynchronously,
returns the request thread.
|
def get_locations_for_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List top open activities # noqa: E501
Get top open locations for a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_locations_for_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: OpenLocations
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields', 'count', 'offset'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_locations_for_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/locations', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='OpenLocations', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, **kwargs)
|
69,523 |
mailchimp_marketing.api.reports_api
|
get_sub_reports_for_campaign
|
List child campaign reports # noqa: E501
Get a list of reports with child campaigns for a specific parent campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_sub_reports_for_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: CampaignSubReports
If the method is called asynchronously,
returns the request thread.
|
def get_sub_reports_for_campaign(self, campaign_id, **kwargs): # noqa: E501
"""List child campaign reports # noqa: E501
Get a list of reports with child campaigns for a specific parent campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_sub_reports_for_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: CampaignSubReports
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_sub_reports_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_sub_reports_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, **kwargs)
|
69,524 |
mailchimp_marketing.api.reports_api
|
get_sub_reports_for_campaign_with_http_info
|
List child campaign reports # noqa: E501
Get a list of reports with child campaigns for a specific parent campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_sub_reports_for_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: CampaignSubReports
If the method is called asynchronously,
returns the request thread.
|
def get_sub_reports_for_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List child campaign reports # noqa: E501
Get a list of reports with child campaigns for a specific parent campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_sub_reports_for_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: CampaignSubReports
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_sub_reports_for_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/sub-reports', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CampaignSubReports', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, **kwargs)
|
69,525 |
mailchimp_marketing.api.reports_api
|
get_subscriber_info
|
Get clicked link subscriber # noqa: E501
Get information about a specific subscriber who clicked a link in a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_subscriber_info(campaign_id, link_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str link_id: The id for the link. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: ClickDetailMember
If the method is called asynchronously,
returns the request thread.
|
def get_subscriber_info(self, campaign_id, link_id, subscriber_hash, **kwargs): # noqa: E501
"""Get clicked link subscriber # noqa: E501
Get information about a specific subscriber who clicked a link in a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_subscriber_info(campaign_id, link_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str link_id: The id for the link. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: ClickDetailMember
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_subscriber_info_with_http_info(campaign_id, link_id, subscriber_hash, **kwargs) # noqa: E501
else:
(data) = self.get_subscriber_info_with_http_info(campaign_id, link_id, subscriber_hash, **kwargs) # noqa: E501
return data
|
(self, campaign_id, link_id, subscriber_hash, **kwargs)
|
69,526 |
mailchimp_marketing.api.reports_api
|
get_subscriber_info_for_opened_campaign
|
Get opened campaign subscriber # noqa: E501
Get information about a specific subscriber who opened a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_subscriber_info_for_opened_campaign(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: OpenActivity
If the method is called asynchronously,
returns the request thread.
|
def get_subscriber_info_for_opened_campaign(self, campaign_id, subscriber_hash, **kwargs): # noqa: E501
"""Get opened campaign subscriber # noqa: E501
Get information about a specific subscriber who opened a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_subscriber_info_for_opened_campaign(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: OpenActivity
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_subscriber_info_for_opened_campaign_with_http_info(campaign_id, subscriber_hash, **kwargs) # noqa: E501
else:
(data) = self.get_subscriber_info_for_opened_campaign_with_http_info(campaign_id, subscriber_hash, **kwargs) # noqa: E501
return data
|
(self, campaign_id, subscriber_hash, **kwargs)
|
69,527 |
mailchimp_marketing.api.reports_api
|
get_subscriber_info_for_opened_campaign_with_http_info
|
Get opened campaign subscriber # noqa: E501
Get information about a specific subscriber who opened a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_subscriber_info_for_opened_campaign_with_http_info(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: OpenActivity
If the method is called asynchronously,
returns the request thread.
|
def get_subscriber_info_for_opened_campaign_with_http_info(self, campaign_id, subscriber_hash, **kwargs): # noqa: E501
"""Get opened campaign subscriber # noqa: E501
Get information about a specific subscriber who opened a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_subscriber_info_for_opened_campaign_with_http_info(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: OpenActivity
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'subscriber_hash', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_subscriber_info_for_opened_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
# verify the required parameter 'subscriber_hash' is set
if ('subscriber_hash' not in params or
params['subscriber_hash'] is None):
raise ValueError("Missing the required parameter `subscriber_hash` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
if 'subscriber_hash' in params:
path_params['subscriber_hash'] = params['subscriber_hash'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/open-details/{subscriber_hash}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='OpenActivity', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, subscriber_hash, **kwargs)
|
69,528 |
mailchimp_marketing.api.reports_api
|
get_subscriber_info_with_http_info
|
Get clicked link subscriber # noqa: E501
Get information about a specific subscriber who clicked a link in a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_subscriber_info_with_http_info(campaign_id, link_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str link_id: The id for the link. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: ClickDetailMember
If the method is called asynchronously,
returns the request thread.
|
def get_subscriber_info_with_http_info(self, campaign_id, link_id, subscriber_hash, **kwargs): # noqa: E501
"""Get clicked link subscriber # noqa: E501
Get information about a specific subscriber who clicked a link in a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_subscriber_info_with_http_info(campaign_id, link_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str link_id: The id for the link. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: ClickDetailMember
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'link_id', 'subscriber_hash', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_subscriber_info" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
# verify the required parameter 'link_id' is set
if ('link_id' not in params or
params['link_id'] is None):
raise ValueError("Missing the required parameter `link_id` when calling ``") # noqa: E501
# verify the required parameter 'subscriber_hash' is set
if ('subscriber_hash' not in params or
params['subscriber_hash'] is None):
raise ValueError("Missing the required parameter `subscriber_hash` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
if 'link_id' in params:
path_params['link_id'] = params['link_id'] # noqa: E501
if 'subscriber_hash' in params:
path_params['subscriber_hash'] = params['subscriber_hash'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ClickDetailMember', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, link_id, subscriber_hash, **kwargs)
|
69,529 |
mailchimp_marketing.api.reports_api
|
get_subscribers_info
|
List clicked link subscribers # noqa: E501
Get information about list members who clicked on a specific link in a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_subscribers_info(campaign_id, link_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str link_id: The id for the link. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: ClickDetailMembers
If the method is called asynchronously,
returns the request thread.
|
def get_subscribers_info(self, campaign_id, link_id, **kwargs): # noqa: E501
"""List clicked link subscribers # noqa: E501
Get information about list members who clicked on a specific link in a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_subscribers_info(campaign_id, link_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str link_id: The id for the link. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: ClickDetailMembers
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_subscribers_info_with_http_info(campaign_id, link_id, **kwargs) # noqa: E501
else:
(data) = self.get_subscribers_info_with_http_info(campaign_id, link_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, link_id, **kwargs)
|
69,530 |
mailchimp_marketing.api.reports_api
|
get_subscribers_info_with_http_info
|
List clicked link subscribers # noqa: E501
Get information about list members who clicked on a specific link in a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_subscribers_info_with_http_info(campaign_id, link_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str link_id: The id for the link. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: ClickDetailMembers
If the method is called asynchronously,
returns the request thread.
|
def get_subscribers_info_with_http_info(self, campaign_id, link_id, **kwargs): # noqa: E501
"""List clicked link subscribers # noqa: E501
Get information about list members who clicked on a specific link in a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_subscribers_info_with_http_info(campaign_id, link_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str link_id: The id for the link. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: ClickDetailMembers
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'link_id', 'fields', 'exclude_fields', 'count', 'offset'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_subscribers_info" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
# verify the required parameter 'link_id' is set
if ('link_id' not in params or
params['link_id'] is None):
raise ValueError("Missing the required parameter `link_id` when calling ``") # noqa: E501
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
if 'link_id' in params:
path_params['link_id'] = params['link_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/click-details/{link_id}/members', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ClickDetailMembers', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, link_id, **kwargs)
|
69,531 |
mailchimp_marketing.api.reports_api
|
get_unsubscribed_list_for_campaign
|
List unsubscribed members # noqa: E501
Get information about members who have unsubscribed from a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_unsubscribed_list_for_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: Unsubscribes
If the method is called asynchronously,
returns the request thread.
|
def get_unsubscribed_list_for_campaign(self, campaign_id, **kwargs): # noqa: E501
"""List unsubscribed members # noqa: E501
Get information about members who have unsubscribed from a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_unsubscribed_list_for_campaign(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: Unsubscribes
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_unsubscribed_list_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
else:
(data) = self.get_unsubscribed_list_for_campaign_with_http_info(campaign_id, **kwargs) # noqa: E501
return data
|
(self, campaign_id, **kwargs)
|
69,532 |
mailchimp_marketing.api.reports_api
|
get_unsubscribed_list_for_campaign_with_http_info
|
List unsubscribed members # noqa: E501
Get information about members who have unsubscribed from a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_unsubscribed_list_for_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: Unsubscribes
If the method is called asynchronously,
returns the request thread.
|
def get_unsubscribed_list_for_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E501
"""List unsubscribed members # noqa: E501
Get information about members who have unsubscribed from a specific campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_unsubscribed_list_for_campaign_with_http_info(campaign_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param int count: The number of records to return. Default value is 10. Maximum value is 1000
:param int offset: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
:return: Unsubscribes
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'fields', 'exclude_fields', 'count', 'offset'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_unsubscribed_list_for_campaign" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
if 'count' in params and params['count'] > 1000: # noqa: E501
raise ValueError("Invalid value for parameter `count` when calling ``, must be a value less than or equal to `1000`") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'count' in params:
query_params.append(('count', params['count'])) # noqa: E501
if 'offset' in params:
query_params.append(('offset', params['offset'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/unsubscribed', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Unsubscribes', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, **kwargs)
|
69,533 |
mailchimp_marketing.api.reports_api
|
get_unsubscribed_list_member
|
Get unsubscribed member # noqa: E501
Get information about a specific list member who unsubscribed from a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_unsubscribed_list_member(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: Unsubscribes
If the method is called asynchronously,
returns the request thread.
|
def get_unsubscribed_list_member(self, campaign_id, subscriber_hash, **kwargs): # noqa: E501
"""Get unsubscribed member # noqa: E501
Get information about a specific list member who unsubscribed from a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_unsubscribed_list_member(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: Unsubscribes
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_unsubscribed_list_member_with_http_info(campaign_id, subscriber_hash, **kwargs) # noqa: E501
else:
(data) = self.get_unsubscribed_list_member_with_http_info(campaign_id, subscriber_hash, **kwargs) # noqa: E501
return data
|
(self, campaign_id, subscriber_hash, **kwargs)
|
69,534 |
mailchimp_marketing.api.reports_api
|
get_unsubscribed_list_member_with_http_info
|
Get unsubscribed member # noqa: E501
Get information about a specific list member who unsubscribed from a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_unsubscribed_list_member_with_http_info(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: Unsubscribes
If the method is called asynchronously,
returns the request thread.
|
def get_unsubscribed_list_member_with_http_info(self, campaign_id, subscriber_hash, **kwargs): # noqa: E501
"""Get unsubscribed member # noqa: E501
Get information about a specific list member who unsubscribed from a campaign. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_unsubscribed_list_member_with_http_info(campaign_id, subscriber_hash, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str campaign_id: The unique id for the campaign. (required)
:param str subscriber_hash: The MD5 hash of the lowercase version of the list member's email address. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: Unsubscribes
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['campaign_id', 'subscriber_hash', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_unsubscribed_list_member" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'campaign_id' is set
if ('campaign_id' not in params or
params['campaign_id'] is None):
raise ValueError("Missing the required parameter `campaign_id` when calling ``") # noqa: E501
# verify the required parameter 'subscriber_hash' is set
if ('subscriber_hash' not in params or
params['subscriber_hash'] is None):
raise ValueError("Missing the required parameter `subscriber_hash` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'campaign_id' in params:
path_params['campaign_id'] = params['campaign_id'] # noqa: E501
if 'subscriber_hash' in params:
path_params['subscriber_hash'] = params['subscriber_hash'] # noqa: E501
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/reports/{campaign_id}/unsubscribed/{subscriber_hash}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Unsubscribes', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, campaign_id, subscriber_hash, **kwargs)
|
69,535 |
mailchimp_marketing.api.root_api
|
RootApi
|
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 RootApi(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_client):
self.api_client = api_client
def get_root(self, **kwargs): # noqa: E501
"""List api root resources # noqa: E501
Get links to all other resources available in the API. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_root(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: APIRoot
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_root_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_root_with_http_info(**kwargs) # noqa: E501
return data
def get_root_with_http_info(self, **kwargs): # noqa: E501
"""List api root resources # noqa: E501
Get links to all other resources available in the API. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_root_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: APIRoot
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_root" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='APIRoot', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(api_client)
|
69,537 |
mailchimp_marketing.api.root_api
|
get_root
|
List api root resources # noqa: E501
Get links to all other resources available in the API. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_root(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: APIRoot
If the method is called asynchronously,
returns the request thread.
|
def get_root(self, **kwargs): # noqa: E501
"""List api root resources # noqa: E501
Get links to all other resources available in the API. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_root(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: APIRoot
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.get_root_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.get_root_with_http_info(**kwargs) # noqa: E501
return data
|
(self, **kwargs)
|
69,538 |
mailchimp_marketing.api.root_api
|
get_root_with_http_info
|
List api root resources # noqa: E501
Get links to all other resources available in the API. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_root_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: APIRoot
If the method is called asynchronously,
returns the request thread.
|
def get_root_with_http_info(self, **kwargs): # noqa: E501
"""List api root resources # noqa: E501
Get links to all other resources available in the API. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_root_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: APIRoot
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_root" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='APIRoot', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, **kwargs)
|
69,539 |
mailchimp_marketing.api.search_campaigns_api
|
SearchCampaignsApi
|
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 SearchCampaignsApi(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_client):
self.api_client = api_client
def search(self, query, **kwargs): # noqa: E501
"""Search campaigns # noqa: E501
Search all campaigns for the specified query terms. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search(query, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str query: The search query used to filter results. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: Campaigns
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.search_with_http_info(query, **kwargs) # noqa: E501
else:
(data) = self.search_with_http_info(query, **kwargs) # noqa: E501
return data
def search_with_http_info(self, query, **kwargs): # noqa: E501
"""Search campaigns # noqa: E501
Search all campaigns for the specified query terms. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_with_http_info(query, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str query: The search query used to filter results. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: Campaigns
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['query', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method search" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'query' is set
if ('query' not in params or
params['query'] is None):
raise ValueError("Missing the required parameter `query` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'query' in params:
query_params.append(('query', params['query'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/search-campaigns', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Campaigns', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(api_client)
|
69,541 |
mailchimp_marketing.api.search_campaigns_api
|
search
|
Search campaigns # noqa: E501
Search all campaigns for the specified query terms. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search(query, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str query: The search query used to filter results. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: Campaigns
If the method is called asynchronously,
returns the request thread.
|
def search(self, query, **kwargs): # noqa: E501
"""Search campaigns # noqa: E501
Search all campaigns for the specified query terms. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search(query, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str query: The search query used to filter results. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: Campaigns
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.search_with_http_info(query, **kwargs) # noqa: E501
else:
(data) = self.search_with_http_info(query, **kwargs) # noqa: E501
return data
|
(self, query, **kwargs)
|
69,542 |
mailchimp_marketing.api.search_campaigns_api
|
search_with_http_info
|
Search campaigns # noqa: E501
Search all campaigns for the specified query terms. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_with_http_info(query, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str query: The search query used to filter results. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: Campaigns
If the method is called asynchronously,
returns the request thread.
|
def search_with_http_info(self, query, **kwargs): # noqa: E501
"""Search campaigns # noqa: E501
Search all campaigns for the specified query terms. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_with_http_info(query, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str query: The search query used to filter results. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:return: Campaigns
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['query', 'fields', 'exclude_fields'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method search" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'query' is set
if ('query' not in params or
params['query'] is None):
raise ValueError("Missing the required parameter `query` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'query' in params:
query_params.append(('query', params['query'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/search-campaigns', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Campaigns', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, query, **kwargs)
|
69,543 |
mailchimp_marketing.api.search_members_api
|
SearchMembersApi
|
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 SearchMembersApi(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_client):
self.api_client = api_client
def search(self, query, **kwargs): # noqa: E501
"""Search members # noqa: E501
Search for list members. This search can be restricted to a specific list, or can be used to search across all lists in an account. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search(query, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str query: The search query used to filter results. Query should be a valid email, or a string representing a contact's first or last name. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param str list_id: The unique id for the list.
:return: Members
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.search_with_http_info(query, **kwargs) # noqa: E501
else:
(data) = self.search_with_http_info(query, **kwargs) # noqa: E501
return data
def search_with_http_info(self, query, **kwargs): # noqa: E501
"""Search members # noqa: E501
Search for list members. This search can be restricted to a specific list, or can be used to search across all lists in an account. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_with_http_info(query, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str query: The search query used to filter results. Query should be a valid email, or a string representing a contact's first or last name. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param str list_id: The unique id for the list.
:return: Members
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['query', 'fields', 'exclude_fields', 'list_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method search" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'query' is set
if ('query' not in params or
params['query'] is None):
raise ValueError("Missing the required parameter `query` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'query' in params:
query_params.append(('query', params['query'])) # noqa: E501
if 'list_id' in params:
query_params.append(('list_id', params['list_id'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/search-members', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Members', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(api_client)
|
69,545 |
mailchimp_marketing.api.search_members_api
|
search
|
Search members # noqa: E501
Search for list members. This search can be restricted to a specific list, or can be used to search across all lists in an account. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search(query, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str query: The search query used to filter results. Query should be a valid email, or a string representing a contact's first or last name. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param str list_id: The unique id for the list.
:return: Members
If the method is called asynchronously,
returns the request thread.
|
def search(self, query, **kwargs): # noqa: E501
"""Search members # noqa: E501
Search for list members. This search can be restricted to a specific list, or can be used to search across all lists in an account. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search(query, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str query: The search query used to filter results. Query should be a valid email, or a string representing a contact's first or last name. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param str list_id: The unique id for the list.
:return: Members
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.search_with_http_info(query, **kwargs) # noqa: E501
else:
(data) = self.search_with_http_info(query, **kwargs) # noqa: E501
return data
|
(self, query, **kwargs)
|
69,546 |
mailchimp_marketing.api.search_members_api
|
search_with_http_info
|
Search members # noqa: E501
Search for list members. This search can be restricted to a specific list, or can be used to search across all lists in an account. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_with_http_info(query, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str query: The search query used to filter results. Query should be a valid email, or a string representing a contact's first or last name. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param str list_id: The unique id for the list.
:return: Members
If the method is called asynchronously,
returns the request thread.
|
def search_with_http_info(self, query, **kwargs): # noqa: E501
"""Search members # noqa: E501
Search for list members. This search can be restricted to a specific list, or can be used to search across all lists in an account. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_with_http_info(query, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str query: The search query used to filter results. Query should be a valid email, or a string representing a contact's first or last name. (required)
:param list[str] fields: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
:param list[str] exclude_fields: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
:param str list_id: The unique id for the list.
:return: Members
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['query', 'fields', 'exclude_fields', 'list_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method search" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'query' is set
if ('query' not in params or
params['query'] is None):
raise ValueError("Missing the required parameter `query` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'fields' in params:
query_params.append(('fields', params['fields'])) # noqa: E501
collection_formats['fields'] = 'csv' # noqa: E501
if 'exclude_fields' in params:
query_params.append(('exclude_fields', params['exclude_fields'])) # noqa: E501
collection_formats['exclude_fields'] = 'csv' # noqa: E501
if 'query' in params:
query_params.append(('query', params['query'])) # noqa: E501
if 'list_id' in params:
query_params.append(('list_id', params['list_id'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/search-members', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Members', # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, query, **kwargs)
|
69,547 |
mailchimp_marketing.api.surveys_api
|
SurveysApi
|
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 SurveysApi(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_client):
self.api_client = api_client
def publish_survey(self, list_id, survey_id, **kwargs): # noqa: E501
"""Publish a Survey # noqa: E501
Publish a survey that is in draft, unpublished, or has been previously published and edited. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.publish_survey(list_id, survey_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str survey_id: The ID of the survey. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.publish_survey_with_http_info(list_id, survey_id, **kwargs) # noqa: E501
else:
(data) = self.publish_survey_with_http_info(list_id, survey_id, **kwargs) # noqa: E501
return data
def publish_survey_with_http_info(self, list_id, survey_id, **kwargs): # noqa: E501
"""Publish a Survey # noqa: E501
Publish a survey that is in draft, unpublished, or has been previously published and edited. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.publish_survey_with_http_info(list_id, survey_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str survey_id: The ID of the survey. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['list_id', 'survey_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method publish_survey" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'list_id' is set
if ('list_id' not in params or
params['list_id'] is None):
raise ValueError("Missing the required parameter `list_id` when calling ``") # noqa: E501
# verify the required parameter 'survey_id' is set
if ('survey_id' not in params or
params['survey_id'] is None):
raise ValueError("Missing the required parameter `survey_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'list_id' in params:
path_params['list_id'] = params['list_id'] # noqa: E501
if 'survey_id' in params:
path_params['survey_id'] = params['survey_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/lists/{list_id}/surveys/{survey_id}/actions/publish', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def unpublish_survey(self, list_id, survey_id, **kwargs): # noqa: E501
"""Unpublish a Survey # noqa: E501
Unpublish a survey that has been published. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.unpublish_survey(list_id, survey_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str survey_id: The ID of the survey. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.unpublish_survey_with_http_info(list_id, survey_id, **kwargs) # noqa: E501
else:
(data) = self.unpublish_survey_with_http_info(list_id, survey_id, **kwargs) # noqa: E501
return data
def unpublish_survey_with_http_info(self, list_id, survey_id, **kwargs): # noqa: E501
"""Unpublish a Survey # noqa: E501
Unpublish a survey that has been published. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.unpublish_survey_with_http_info(list_id, survey_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str survey_id: The ID of the survey. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['list_id', 'survey_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method unpublish_survey" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'list_id' is set
if ('list_id' not in params or
params['list_id'] is None):
raise ValueError("Missing the required parameter `list_id` when calling ``") # noqa: E501
# verify the required parameter 'survey_id' is set
if ('survey_id' not in params or
params['survey_id'] is None):
raise ValueError("Missing the required parameter `survey_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'list_id' in params:
path_params['list_id'] = params['list_id'] # noqa: E501
if 'survey_id' in params:
path_params['survey_id'] = params['survey_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/lists/{list_id}/surveys/{survey_id}/actions/unpublish', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(api_client)
|
69,549 |
mailchimp_marketing.api.surveys_api
|
publish_survey
|
Publish a Survey # noqa: E501
Publish a survey that is in draft, unpublished, or has been previously published and edited. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.publish_survey(list_id, survey_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str survey_id: The ID of the survey. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def publish_survey(self, list_id, survey_id, **kwargs): # noqa: E501
"""Publish a Survey # noqa: E501
Publish a survey that is in draft, unpublished, or has been previously published and edited. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.publish_survey(list_id, survey_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str survey_id: The ID of the survey. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.publish_survey_with_http_info(list_id, survey_id, **kwargs) # noqa: E501
else:
(data) = self.publish_survey_with_http_info(list_id, survey_id, **kwargs) # noqa: E501
return data
|
(self, list_id, survey_id, **kwargs)
|
69,550 |
mailchimp_marketing.api.surveys_api
|
publish_survey_with_http_info
|
Publish a Survey # noqa: E501
Publish a survey that is in draft, unpublished, or has been previously published and edited. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.publish_survey_with_http_info(list_id, survey_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str survey_id: The ID of the survey. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def publish_survey_with_http_info(self, list_id, survey_id, **kwargs): # noqa: E501
"""Publish a Survey # noqa: E501
Publish a survey that is in draft, unpublished, or has been previously published and edited. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.publish_survey_with_http_info(list_id, survey_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str survey_id: The ID of the survey. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['list_id', 'survey_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method publish_survey" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'list_id' is set
if ('list_id' not in params or
params['list_id'] is None):
raise ValueError("Missing the required parameter `list_id` when calling ``") # noqa: E501
# verify the required parameter 'survey_id' is set
if ('survey_id' not in params or
params['survey_id'] is None):
raise ValueError("Missing the required parameter `survey_id` when calling ``") # noqa: E501
collection_formats = {}
path_params = {}
if 'list_id' in params:
path_params['list_id'] = params['list_id'] # noqa: E501
if 'survey_id' in params:
path_params['survey_id'] = params['survey_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/problem+json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/lists/{list_id}/surveys/{survey_id}/actions/publish', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
|
(self, list_id, survey_id, **kwargs)
|
69,551 |
mailchimp_marketing.api.surveys_api
|
unpublish_survey
|
Unpublish a Survey # noqa: E501
Unpublish a survey that has been published. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.unpublish_survey(list_id, survey_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str survey_id: The ID of the survey. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
|
def unpublish_survey(self, list_id, survey_id, **kwargs): # noqa: E501
"""Unpublish a Survey # noqa: E501
Unpublish a survey that has been published. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.unpublish_survey(list_id, survey_id, async_req=True)
>>> result = thread.get()
:param async_req bool
:param str list_id: The unique ID for the list. (required)
:param str survey_id: The ID of the survey. (required)
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.unpublish_survey_with_http_info(list_id, survey_id, **kwargs) # noqa: E501
else:
(data) = self.unpublish_survey_with_http_info(list_id, survey_id, **kwargs) # noqa: E501
return data
|
(self, list_id, survey_id, **kwargs)
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.