Module presalytics.client.presalytics_story.api.default_api
Story
This API is the main entry point for creating, editing and publishing analytics throught the Presalytics API # noqa: E501
The version of the OpenAPI document: 0.3.1 Generated by: https://openapi-generator.tech
Expand source code Browse git
# coding: utf-8
"""
Story
This API is the main entry point for creating, editing and publishing analytics throught the Presalytics API # noqa: E501
The version of the OpenAPI document: 0.3.1
Generated by: https://openapi-generator.tech
"""
from __future__ import absolute_import
import re # noqa: F401
# python 2 and python 3 compatibility library
import six
from presalytics.client.presalytics_story.api_client import ApiClient
from presalytics.client.presalytics_story.exceptions import (
ApiTypeError,
ApiValueError
)
class DefaultApi(object):
"""NOTE: This class is auto generated by OpenAPI Generator
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
def collaborators_post(self, collaborator_bulk_update_request, **kwargs): # noqa: E501
"""Collborators: Bulk Update (Admin Only) # noqa: E501
Allows for bulk updates on collaborator metadata. Restricted to internal admins # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.collaborators_post(collaborator_bulk_update_request, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param CollaboratorBulkUpdateRequest collaborator_bulk_update_request: parameters to identify an update a collaborator across multiple stories (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: list[PermissionType]
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.collaborators_post_with_http_info(collaborator_bulk_update_request, **kwargs) # noqa: E501
def collaborators_post_with_http_info(self, collaborator_bulk_update_request, **kwargs): # noqa: E501
"""Collborators: Bulk Update (Admin Only) # noqa: E501
Allows for bulk updates on collaborator metadata. Restricted to internal admins # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.collaborators_post_with_http_info(collaborator_bulk_update_request, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param CollaboratorBulkUpdateRequest collaborator_bulk_update_request: parameters to identify an update a collaborator across multiple stories (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(list[PermissionType], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['collaborator_bulk_update_request'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method collaborators_post" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'collaborator_bulk_update_request' is set
if ('collaborator_bulk_update_request' not in local_var_params or
local_var_params['collaborator_bulk_update_request'] is None):
raise ApiValueError("Missing the required parameter `collaborator_bulk_update_request` when calling `collaborators_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'collaborator_bulk_update_request' in local_var_params:
body_params = local_var_params['collaborator_bulk_update_request']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/collaborators', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[PermissionType]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def get_environment(self, **kwargs): # noqa: E501
"""Environment: Get # noqa: E501
pass rendering metadata to the client-side scripts # 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_environment(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: object
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.get_environment_with_http_info(**kwargs) # noqa: E501
def get_environment_with_http_info(self, **kwargs): # noqa: E501
"""Environment: Get # noqa: E501
pass rendering metadata to the client-side scripts # 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_environment_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(object, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
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')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_environment" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/environment/', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='object', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def session_id_delete(self, session_id, **kwargs): # noqa: E501
"""Sessions: Delete by Id # noqa: E501
Remove a session and dependant data. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.session_id_delete(session_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str session_id: The primary key for a view session (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.session_id_delete_with_http_info(session_id, **kwargs) # noqa: E501
def session_id_delete_with_http_info(self, session_id, **kwargs): # noqa: E501
"""Sessions: Delete by Id # noqa: E501
Remove a session and dependant data. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.session_id_delete_with_http_info(session_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str session_id: The primary key for a view session (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['session_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')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method session_id_delete" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'session_id' is set
if ('session_id' not in local_var_params or
local_var_params['session_id'] is None):
raise ApiValueError("Missing the required parameter `session_id` when calling `session_id_delete`") # noqa: E501
collection_formats = {}
path_params = {}
if 'session_id' in local_var_params:
path_params['session_id'] = local_var_params['session_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/sessions/{session_id}', 'DELETE',
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=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def session_id_get(self, session_id, **kwargs): # noqa: E501
"""Sessions: Get # noqa: E501
Get session metadata # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.session_id_get(session_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str session_id: The primary key for a view session (required)
:param bool include_relationships: Indicate whether the returned object should include child relationships
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Session
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.session_id_get_with_http_info(session_id, **kwargs) # noqa: E501
def session_id_get_with_http_info(self, session_id, **kwargs): # noqa: E501
"""Sessions: Get # noqa: E501
Get session metadata # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.session_id_get_with_http_info(session_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str session_id: The primary key for a view session (required)
:param bool include_relationships: Indicate whether the returned object should include child relationships
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Session, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['session_id', 'include_relationships'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method session_id_get" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'session_id' is set
if ('session_id' not in local_var_params or
local_var_params['session_id'] is None):
raise ApiValueError("Missing the required parameter `session_id` when calling `session_id_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'session_id' in local_var_params:
path_params['session_id'] = local_var_params['session_id'] # noqa: E501
query_params = []
if 'include_relationships' in local_var_params:
query_params.append(('include_relationships', local_var_params['include_relationships'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/sessions/{session_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Session', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def sessions_id_views_get(self, session_id, **kwargs): # noqa: E501
"""Views: List Session Views # noqa: E501
Get data for all views in a session # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sessions_id_views_get(session_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str session_id: The primary key for a view session (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: list[View]
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.sessions_id_views_get_with_http_info(session_id, **kwargs) # noqa: E501
def sessions_id_views_get_with_http_info(self, session_id, **kwargs): # noqa: E501
"""Views: List Session Views # noqa: E501
Get data for all views in a session # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sessions_id_views_get_with_http_info(session_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str session_id: The primary key for a view session (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(list[View], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['session_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')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method sessions_id_views_get" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'session_id' is set
if ('session_id' not in local_var_params or
local_var_params['session_id'] is None):
raise ApiValueError("Missing the required parameter `session_id` when calling `sessions_id_views_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'session_id' in local_var_params:
path_params['session_id'] = local_var_params['session_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/sessions/{session_id}/views', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[View]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def sessions_id_views_post(self, session_id, required_parameters_to_create_a_view, **kwargs): # noqa: E501
"""Views: Create A Session View # noqa: E501
Create a page view object for a viewing session # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sessions_id_views_post(session_id, required_parameters_to_create_a_view, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str session_id: The primary key for a view session (required)
:param RequiredParametersToCreateAView required_parameters_to_create_a_view: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: View
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.sessions_id_views_post_with_http_info(session_id, required_parameters_to_create_a_view, **kwargs) # noqa: E501
def sessions_id_views_post_with_http_info(self, session_id, required_parameters_to_create_a_view, **kwargs): # noqa: E501
"""Views: Create A Session View # noqa: E501
Create a page view object for a viewing session # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sessions_id_views_post_with_http_info(session_id, required_parameters_to_create_a_view, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str session_id: The primary key for a view session (required)
:param RequiredParametersToCreateAView required_parameters_to_create_a_view: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(View, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['session_id', 'required_parameters_to_create_a_view'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method sessions_id_views_post" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'session_id' is set
if ('session_id' not in local_var_params or
local_var_params['session_id'] is None):
raise ApiValueError("Missing the required parameter `session_id` when calling `sessions_id_views_post`") # noqa: E501
# verify the required parameter 'required_parameters_to_create_a_view' is set
if ('required_parameters_to_create_a_view' not in local_var_params or
local_var_params['required_parameters_to_create_a_view'] is None):
raise ApiValueError("Missing the required parameter `required_parameters_to_create_a_view` when calling `sessions_id_views_post`") # noqa: E501
collection_formats = {}
path_params = {}
if 'session_id' in local_var_params:
path_params['session_id'] = local_var_params['session_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'required_parameters_to_create_a_view' in local_var_params:
body_params = local_var_params['required_parameters_to_create_a_view']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/sessions/{session_id}/views', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='View', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def spec_no_tags(self, **kwargs): # noqa: E501
"""Specification: No tags # noqa: E501
json-formatted version of this spec with the tags removed to help with codegen processes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.spec_no_tags(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.spec_no_tags_with_http_info(**kwargs) # noqa: E501
def spec_no_tags_with_http_info(self, **kwargs): # noqa: E501
"""Specification: No tags # noqa: E501
json-formatted version of this spec with the tags removed to help with codegen processes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.spec_no_tags_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
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')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method spec_no_tags" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/no_tags_spec', 'GET',
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=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_get(self, **kwargs): # noqa: E501
"""Story: Get List of User Stories # noqa: E501
Returns a list of stories for this user identifie via the access token presentated to 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.story_get(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param bool include_relationships: Indicate whether the returned object should include child relationships
:param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: list[Story]
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_get_with_http_info(**kwargs) # noqa: E501
def story_get_with_http_info(self, **kwargs): # noqa: E501
"""Story: Get List of User Stories # noqa: E501
Returns a list of stories for this user identifie via the access token presentated to 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.story_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param bool include_relationships: Indicate whether the returned object should include child relationships
:param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(list[Story], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['include_relationships', 'include_outline'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_get" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'include_relationships' in local_var_params:
query_params.append(('include_relationships', local_var_params['include_relationships'])) # noqa: E501
if 'include_outline' in local_var_params:
query_params.append(('include_outline', local_var_params['include_outline'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # 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='list[Story]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_id_collaborators_get(self, id, **kwargs): # noqa: E501
"""Story Collaborators: List # noqa: E501
Gets a list users that can read or edit this story # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: list[StoryCollaborator]
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_id_collaborators_get_with_http_info(id, **kwargs) # noqa: E501
def story_id_collaborators_get_with_http_info(self, id, **kwargs): # noqa: E501
"""Story Collaborators: List # noqa: E501
Gets a list users that can read or edit this story # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(list[StoryCollaborator], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['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')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_id_collaborators_get" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `story_id_collaborators_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{id}/collaborators', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[StoryCollaborator]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_id_collaborators_inactive_post(self, id, modify_inactive_collaborator, **kwargs): # noqa: E501
"""Story Collaborators: Edit Inactive User Permission # noqa: E501
Edit story permissions for inactive users. Requires admin rights. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_inactive_post(id, modify_inactive_collaborator, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param ModifyInactiveCollaborator modify_inactive_collaborator: Collaborator user id and permission type (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: StoryCollaborator
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_id_collaborators_inactive_post_with_http_info(id, modify_inactive_collaborator, **kwargs) # noqa: E501
def story_id_collaborators_inactive_post_with_http_info(self, id, modify_inactive_collaborator, **kwargs): # noqa: E501
"""Story Collaborators: Edit Inactive User Permission # noqa: E501
Edit story permissions for inactive users. Requires admin rights. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_inactive_post_with_http_info(id, modify_inactive_collaborator, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param ModifyInactiveCollaborator modify_inactive_collaborator: Collaborator user id and permission type (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(StoryCollaborator, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['id', 'modify_inactive_collaborator'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_id_collaborators_inactive_post" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `story_id_collaborators_inactive_post`") # noqa: E501
# verify the required parameter 'modify_inactive_collaborator' is set
if ('modify_inactive_collaborator' not in local_var_params or
local_var_params['modify_inactive_collaborator'] is None):
raise ApiValueError("Missing the required parameter `modify_inactive_collaborator` when calling `story_id_collaborators_inactive_post`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'modify_inactive_collaborator' in local_var_params:
body_params = local_var_params['modify_inactive_collaborator']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{id}/collaborators/inactive', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='StoryCollaborator', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_id_collaborators_post(self, id, add_new_collaborator_request, **kwargs): # noqa: E501
"""Story Collaborators: Add New User # noqa: E501
Add a colloborator to this story # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_post(id, add_new_collaborator_request, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param AddNewCollaboratorRequest add_new_collaborator_request: Collaborator user id and permission type (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: StoryCollaborator
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_id_collaborators_post_with_http_info(id, add_new_collaborator_request, **kwargs) # noqa: E501
def story_id_collaborators_post_with_http_info(self, id, add_new_collaborator_request, **kwargs): # noqa: E501
"""Story Collaborators: Add New User # noqa: E501
Add a colloborator to this story # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_post_with_http_info(id, add_new_collaborator_request, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param AddNewCollaboratorRequest add_new_collaborator_request: Collaborator user id and permission type (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(StoryCollaborator, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['id', 'add_new_collaborator_request'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_id_collaborators_post" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `story_id_collaborators_post`") # noqa: E501
# verify the required parameter 'add_new_collaborator_request' is set
if ('add_new_collaborator_request' not in local_var_params or
local_var_params['add_new_collaborator_request'] is None):
raise ApiValueError("Missing the required parameter `add_new_collaborator_request` when calling `story_id_collaborators_post`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'add_new_collaborator_request' in local_var_params:
body_params = local_var_params['add_new_collaborator_request']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{id}/collaborators', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='StoryCollaborator', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_id_collaborators_userid_delete(self, id, story_collaborator_userid, **kwargs): # noqa: E501
"""Story Collaborators: Remove User # noqa: E501
Remove a collaborator from this story # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_userid_delete(id, story_collaborator_userid, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_id_collaborators_userid_delete_with_http_info(id, story_collaborator_userid, **kwargs) # noqa: E501
def story_id_collaborators_userid_delete_with_http_info(self, id, story_collaborator_userid, **kwargs): # noqa: E501
"""Story Collaborators: Remove User # noqa: E501
Remove a collaborator from this story # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_userid_delete_with_http_info(id, story_collaborator_userid, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['id', 'story_collaborator_userid'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_id_collaborators_userid_delete" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `story_id_collaborators_userid_delete`") # noqa: E501
# verify the required parameter 'story_collaborator_userid' is set
if ('story_collaborator_userid' not in local_var_params or
local_var_params['story_collaborator_userid'] is None):
raise ApiValueError("Missing the required parameter `story_collaborator_userid` when calling `story_id_collaborators_userid_delete`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
if 'story_collaborator_userid' in local_var_params:
path_params['story_collaborator_userid'] = local_var_params['story_collaborator_userid'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{id}/collaborators/{story_collaborator_userid}', 'DELETE',
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=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_id_collaborators_userid_get(self, id, story_collaborator_userid, **kwargs): # noqa: E501
"""Story Collaborators: Access Permissions # noqa: E501
Data to help you understand the access rights of a particular collaborator on this story # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_userid_get(id, story_collaborator_userid, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: StoryCollaborator
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_id_collaborators_userid_get_with_http_info(id, story_collaborator_userid, **kwargs) # noqa: E501
def story_id_collaborators_userid_get_with_http_info(self, id, story_collaborator_userid, **kwargs): # noqa: E501
"""Story Collaborators: Access Permissions # noqa: E501
Data to help you understand the access rights of a particular collaborator on this story # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_userid_get_with_http_info(id, story_collaborator_userid, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(StoryCollaborator, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['id', 'story_collaborator_userid'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_id_collaborators_userid_get" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `story_id_collaborators_userid_get`") # noqa: E501
# verify the required parameter 'story_collaborator_userid' is set
if ('story_collaborator_userid' not in local_var_params or
local_var_params['story_collaborator_userid'] is None):
raise ApiValueError("Missing the required parameter `story_collaborator_userid` when calling `story_id_collaborators_userid_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
if 'story_collaborator_userid' in local_var_params:
path_params['story_collaborator_userid'] = local_var_params['story_collaborator_userid'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{id}/collaborators/{story_collaborator_userid}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='StoryCollaborator', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_id_collaborators_userid_permissiontype_get(self, id, story_collaborator_userid, permissiontype, **kwargs): # noqa: E501
"""Permissions: Story Authorization for a User # noqa: E501
Check whether user have certain types of permissions. Use http status codes to understand if permission is granted - 204 = Granted, 403 = Forbidden # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_userid_permissiontype_get(id, story_collaborator_userid, permissiontype, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required)
:param str permissiontype: the type of permission requested. can be a permission_type object name (e.g., owner, editor, create, viewer, admin) or a permission type field (e.g., can_edit, can_view, can_add_collaborators, can_delete) (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_id_collaborators_userid_permissiontype_get_with_http_info(id, story_collaborator_userid, permissiontype, **kwargs) # noqa: E501
def story_id_collaborators_userid_permissiontype_get_with_http_info(self, id, story_collaborator_userid, permissiontype, **kwargs): # noqa: E501
"""Permissions: Story Authorization for a User # noqa: E501
Check whether user have certain types of permissions. Use http status codes to understand if permission is granted - 204 = Granted, 403 = Forbidden # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_userid_permissiontype_get_with_http_info(id, story_collaborator_userid, permissiontype, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required)
:param str permissiontype: the type of permission requested. can be a permission_type object name (e.g., owner, editor, create, viewer, admin) or a permission type field (e.g., can_edit, can_view, can_add_collaborators, can_delete) (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['id', 'story_collaborator_userid', 'permissiontype'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_id_collaborators_userid_permissiontype_get" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `story_id_collaborators_userid_permissiontype_get`") # noqa: E501
# verify the required parameter 'story_collaborator_userid' is set
if ('story_collaborator_userid' not in local_var_params or
local_var_params['story_collaborator_userid'] is None):
raise ApiValueError("Missing the required parameter `story_collaborator_userid` when calling `story_id_collaborators_userid_permissiontype_get`") # noqa: E501
# verify the required parameter 'permissiontype' is set
if ('permissiontype' not in local_var_params or
local_var_params['permissiontype'] is None):
raise ApiValueError("Missing the required parameter `permissiontype` when calling `story_id_collaborators_userid_permissiontype_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
if 'story_collaborator_userid' in local_var_params:
path_params['story_collaborator_userid'] = local_var_params['story_collaborator_userid'] # noqa: E501
if 'permissiontype' in local_var_params:
path_params['permissiontype'] = local_var_params['permissiontype'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{id}/collaborators/authorize/{story_collaborator_userid}/{permissiontype}', 'GET',
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=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_id_collaborators_userid_put(self, id, story_collaborator_userid, story_collaborator, **kwargs): # noqa: E501
"""Story Collaborators: Edit Access Rights # noqa: E501
Modify a user's access right to this story (e.g., grant edit permissions) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_userid_put(id, story_collaborator_userid, story_collaborator, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required)
:param StoryCollaborator story_collaborator: Collaborator user id (presalytics userid) and permission type (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: StoryCollaborator
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_id_collaborators_userid_put_with_http_info(id, story_collaborator_userid, story_collaborator, **kwargs) # noqa: E501
def story_id_collaborators_userid_put_with_http_info(self, id, story_collaborator_userid, story_collaborator, **kwargs): # noqa: E501
"""Story Collaborators: Edit Access Rights # noqa: E501
Modify a user's access right to this story (e.g., grant edit permissions) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_userid_put_with_http_info(id, story_collaborator_userid, story_collaborator, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required)
:param StoryCollaborator story_collaborator: Collaborator user id (presalytics userid) and permission type (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(StoryCollaborator, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['id', 'story_collaborator_userid', 'story_collaborator'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_id_collaborators_userid_put" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `story_id_collaborators_userid_put`") # noqa: E501
# verify the required parameter 'story_collaborator_userid' is set
if ('story_collaborator_userid' not in local_var_params or
local_var_params['story_collaborator_userid'] is None):
raise ApiValueError("Missing the required parameter `story_collaborator_userid` when calling `story_id_collaborators_userid_put`") # noqa: E501
# verify the required parameter 'story_collaborator' is set
if ('story_collaborator' not in local_var_params or
local_var_params['story_collaborator'] is None):
raise ApiValueError("Missing the required parameter `story_collaborator` when calling `story_id_collaborators_userid_put`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
if 'story_collaborator_userid' in local_var_params:
path_params['story_collaborator_userid'] = local_var_params['story_collaborator_userid'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'story_collaborator' in local_var_params:
body_params = local_var_params['story_collaborator']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{id}/collaborators/{story_collaborator_userid}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='StoryCollaborator', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_id_d3_id_get(self, id, d3_id, **kwargs): # noqa: E501
"""Story: Get D3 Iframe # noqa: E501
Gets a barebones html document with objects redender by d3 script with a Restrictive Content-Security-Policy. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_d3_id_get(id, d3_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param str d3_id: A d3 figure id from a D3Widget instance in the Presaltyics Python Library (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_id_d3_id_get_with_http_info(id, d3_id, **kwargs) # noqa: E501
def story_id_d3_id_get_with_http_info(self, id, d3_id, **kwargs): # noqa: E501
"""Story: Get D3 Iframe # noqa: E501
Gets a barebones html document with objects redender by d3 script with a Restrictive Content-Security-Policy. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_d3_id_get_with_http_info(id, d3_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param str d3_id: A d3 figure id from a D3Widget instance in the Presaltyics Python Library (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(str, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['id', 'd3_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')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_id_d3_id_get" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `story_id_d3_id_get`") # noqa: E501
# verify the required parameter 'd3_id' is set
if ('d3_id' not in local_var_params or
local_var_params['d3_id'] is None):
raise ApiValueError("Missing the required parameter `d3_id` when calling `story_id_d3_id_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
if 'd3_id' in local_var_params:
path_params['d3_id'] = local_var_params['d3_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(
['text/html']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{id}/d3/{d3_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_id_delete(self, id, **kwargs): # noqa: E501
"""Story: Delete by Id # noqa: E501
Remove a story and dependant data. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_delete(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_id_delete_with_http_info(id, **kwargs) # noqa: E501
def story_id_delete_with_http_info(self, id, **kwargs): # noqa: E501
"""Story: Delete by Id # noqa: E501
Remove a story and dependant data. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_delete_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['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')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_id_delete" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `story_id_delete`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{id}', 'DELETE',
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=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_id_file_ooxmlautomationid_get(self, id, ooxml_automation_id, **kwargs): # noqa: E501
"""Story: Download Updated File # noqa: E501
Redtreives updated story as open office xml file (e.g., .pptx, .docx, .xlsx) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_file_ooxmlautomationid_get(id, ooxml_automation_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param str ooxml_automation_id: the id of the ooxml_automation object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: file
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_id_file_ooxmlautomationid_get_with_http_info(id, ooxml_automation_id, **kwargs) # noqa: E501
def story_id_file_ooxmlautomationid_get_with_http_info(self, id, ooxml_automation_id, **kwargs): # noqa: E501
"""Story: Download Updated File # noqa: E501
Redtreives updated story as open office xml file (e.g., .pptx, .docx, .xlsx) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_file_ooxmlautomationid_get_with_http_info(id, ooxml_automation_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param str ooxml_automation_id: the id of the ooxml_automation object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(file, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['id', 'ooxml_automation_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')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_id_file_ooxmlautomationid_get" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `story_id_file_ooxmlautomationid_get`") # noqa: E501
# verify the required parameter 'ooxml_automation_id' is set
if ('ooxml_automation_id' not in local_var_params or
local_var_params['ooxml_automation_id'] is None):
raise ApiValueError("Missing the required parameter `ooxml_automation_id` when calling `story_id_file_ooxmlautomationid_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
if 'ooxml_automation_id' in local_var_params:
path_params['ooxml_automation_id'] = local_var_params['ooxml_automation_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/vnd.openxmlformats-officedocument.presentationml.presentation', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{id}/file/{ooxml_automation_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='file', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_id_file_post(self, id, **kwargs): # noqa: E501
"""Story: Upload a File To Existing Story # noqa: E501
Upload a file to an existing story # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_file_post(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param bool replace_existing: Indicates whether a put or post method would replace the existing contents
:param str obsolete_id: A primary key pointing to an obsolete item in the story. Item type is context-dependent
:param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times.
:param list[file] file:
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Story
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_id_file_post_with_http_info(id, **kwargs) # noqa: E501
def story_id_file_post_with_http_info(self, id, **kwargs): # noqa: E501
"""Story: Upload a File To Existing Story # noqa: E501
Upload a file to an existing story # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_file_post_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param bool replace_existing: Indicates whether a put or post method would replace the existing contents
:param str obsolete_id: A primary key pointing to an obsolete item in the story. Item type is context-dependent
:param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times.
:param list[file] file:
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Story, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['id', 'replace_existing', 'obsolete_id', 'include_outline', 'file'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_id_file_post" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `story_id_file_post`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
query_params = []
if 'replace_existing' in local_var_params:
query_params.append(('replace_existing', local_var_params['replace_existing'])) # noqa: E501
if 'obsolete_id' in local_var_params:
query_params.append(('obsolete_id', local_var_params['obsolete_id'])) # noqa: E501
if 'include_outline' in local_var_params:
query_params.append(('include_outline', local_var_params['include_outline'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
if 'file' in local_var_params:
local_var_files['file'] = local_var_params['file'] # noqa: E501
collection_formats['file'] = 'csv' # noqa: E501
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['multipart/form-data']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{id}/file', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Story', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_id_get(self, id, **kwargs): # noqa: E501
"""Story: Get by Id # noqa: E501
Returns story metadata, inlcuding json object with story outline # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param bool include_relationships: Indicate whether the returned object should include child relationships
:param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times.
:param bool full: Pull a story object with associated collaborator user, permission, and session data(faster if cached from prior api call)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Story
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_id_get_with_http_info(id, **kwargs) # noqa: E501
def story_id_get_with_http_info(self, id, **kwargs): # noqa: E501
"""Story: Get by Id # noqa: E501
Returns story metadata, inlcuding json object with story outline # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param bool include_relationships: Indicate whether the returned object should include child relationships
:param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times.
:param bool full: Pull a story object with associated collaborator user, permission, and session data(faster if cached from prior api call)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Story, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['id', 'include_relationships', 'include_outline', 'full'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_id_get" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `story_id_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
query_params = []
if 'include_relationships' in local_var_params:
query_params.append(('include_relationships', local_var_params['include_relationships'])) # noqa: E501
if 'include_outline' in local_var_params:
query_params.append(('include_outline', local_var_params['include_outline'])) # noqa: E501
if 'full' in local_var_params:
query_params.append(('full', local_var_params['full'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Story', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_id_maplotlib_responsive_figure_id_get(self, id, figure_id, **kwargs): # noqa: E501
"""Story: Get Matplotlib Iframe # noqa: E501
Gets a barebones html document with a matplotlib chart. Useful for rendering inside responsive iframes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_maplotlib_responsive_figure_id_get(id, figure_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param str figure_id: A matplotlib figure id from a MatplotlibResponsiveFigure instance in the Presaltyics Python Library (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_id_maplotlib_responsive_figure_id_get_with_http_info(id, figure_id, **kwargs) # noqa: E501
def story_id_maplotlib_responsive_figure_id_get_with_http_info(self, id, figure_id, **kwargs): # noqa: E501
"""Story: Get Matplotlib Iframe # noqa: E501
Gets a barebones html document with a matplotlib chart. Useful for rendering inside responsive iframes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_maplotlib_responsive_figure_id_get_with_http_info(id, figure_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param str figure_id: A matplotlib figure id from a MatplotlibResponsiveFigure instance in the Presaltyics Python Library (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(str, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['id', 'figure_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')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_id_maplotlib_responsive_figure_id_get" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `story_id_maplotlib_responsive_figure_id_get`") # noqa: E501
# verify the required parameter 'figure_id' is set
if ('figure_id' not in local_var_params or
local_var_params['figure_id'] is None):
raise ApiValueError("Missing the required parameter `figure_id` when calling `story_id_maplotlib_responsive_figure_id_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
if 'figure_id' in local_var_params:
path_params['figure_id'] = local_var_params['figure_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(
['text/html']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{id}/matplotlib-responsive/{figure_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_id_outline_get(self, id, **kwargs): # noqa: E501
"""Story: Get Story Outline # noqa: E501
Returns Story's outline # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_outline_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_id_outline_get_with_http_info(id, **kwargs) # noqa: E501
def story_id_outline_get_with_http_info(self, id, **kwargs): # noqa: E501
"""Story: Get Story Outline # noqa: E501
Returns Story's outline # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_outline_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(str, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['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')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_id_outline_get" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `story_id_outline_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{id}/outline', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_id_outline_post(self, id, body, **kwargs): # noqa: E501
"""Story: Post Story Outline # noqa: E501
Update a story outline. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_outline_post(id, body, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param str body: A story outline object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_id_outline_post_with_http_info(id, body, **kwargs) # noqa: E501
def story_id_outline_post_with_http_info(self, id, body, **kwargs): # noqa: E501
"""Story: Post Story Outline # noqa: E501
Update a story outline. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_outline_post_with_http_info(id, body, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param str body: A story outline object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['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')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_id_outline_post" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `story_id_outline_post`") # noqa: E501
# verify the required parameter 'body' is set
if ('body' not in local_var_params or
local_var_params['body'] is None):
raise ApiValueError("Missing the required parameter `body` when calling `story_id_outline_post`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in local_var_params:
body_params = local_var_params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{id}/outline', '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=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_id_put(self, id, story, **kwargs): # noqa: E501
"""Story: Modify # noqa: E501
Update story metadata, including story outline # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_put(id, story, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param Story story: The updated story object (required)
:param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Story
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_id_put_with_http_info(id, story, **kwargs) # noqa: E501
def story_id_put_with_http_info(self, id, story, **kwargs): # noqa: E501
"""Story: Modify # noqa: E501
Update story metadata, including story outline # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_put_with_http_info(id, story, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param Story story: The updated story object (required)
:param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Story, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['id', 'story', 'include_outline'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_id_put" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `story_id_put`") # noqa: E501
# verify the required parameter 'story' is set
if ('story' not in local_var_params or
local_var_params['story'] is None):
raise ApiValueError("Missing the required parameter `story` when calling `story_id_put`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
query_params = []
if 'include_outline' in local_var_params:
query_params.append(('include_outline', local_var_params['include_outline'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'story' in local_var_params:
body_params = local_var_params['story']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{id}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Story', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_id_reveal(self, id, **kwargs): # noqa: E501
"""Story: Get Story at Reveal.js Document # noqa: E501
returns an html document containing a reveal.js epresentation of the story # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_reveal(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: str
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_id_reveal_with_http_info(id, **kwargs) # noqa: E501
def story_id_reveal_with_http_info(self, id, **kwargs): # noqa: E501
"""Story: Get Story at Reveal.js Document # noqa: E501
returns an html document containing a reveal.js epresentation of the story # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_reveal_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(str, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['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')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_id_reveal" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `story_id_reveal`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['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', 'text/html']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{id}/reveal', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_id_session_post(self, id, create_session_request, **kwargs): # noqa: E501
"""Sessions: Create a Session # noqa: E501
Create a new session # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_session_post(id, create_session_request, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param CreateSessionRequest create_session_request: Collaborator user id and permission type (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Session
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_id_session_post_with_http_info(id, create_session_request, **kwargs) # noqa: E501
def story_id_session_post_with_http_info(self, id, create_session_request, **kwargs): # noqa: E501
"""Sessions: Create a Session # noqa: E501
Create a new session # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_session_post_with_http_info(id, create_session_request, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param CreateSessionRequest create_session_request: Collaborator user id and permission type (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Session, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['id', 'create_session_request'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_id_session_post" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `story_id_session_post`") # noqa: E501
# verify the required parameter 'create_session_request' is set
if ('create_session_request' not in local_var_params or
local_var_params['create_session_request'] is None):
raise ApiValueError("Missing the required parameter `create_session_request` when calling `story_id_session_post`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'create_session_request' in local_var_params:
body_params = local_var_params['create_session_request']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{id}/sessions', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Session', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_id_sessions_get(self, id, **kwargs): # noqa: E501
"""Sessions: List Story Sessions # noqa: E501
Get a list of sessions asscoaited with this story # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_sessions_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param bool include_relationships: Indicate whether the returned object should include child relationships
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: list[Session]
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_id_sessions_get_with_http_info(id, **kwargs) # noqa: E501
def story_id_sessions_get_with_http_info(self, id, **kwargs): # noqa: E501
"""Sessions: List Story Sessions # noqa: E501
Get a list of sessions asscoaited with this story # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_sessions_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param bool include_relationships: Indicate whether the returned object should include child relationships
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(list[Session], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['id', 'include_relationships'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_id_sessions_get" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `story_id_sessions_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
query_params = []
if 'include_relationships' in local_var_params:
query_params.append(('include_relationships', local_var_params['include_relationships'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{id}/sessions', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[Session]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_id_status_get(self, id, **kwargs): # noqa: E501
"""Story: Get Story Status # noqa: E501
Returns code indicating whether story has active running background and is healthy (e.g., the latest outline is valid) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_status_get(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Status
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_id_status_get_with_http_info(id, **kwargs) # noqa: E501
def story_id_status_get_with_http_info(self, id, **kwargs): # noqa: E501
"""Story: Get Story Status # noqa: E501
Returns code indicating whether story has active running background and is healthy (e.g., the latest outline is valid) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_status_get_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: the id from the story object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Status, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['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')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_id_status_get" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in local_var_params or
local_var_params['id'] is None):
raise ApiValueError("Missing the required parameter `id` when calling `story_id_status_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/{id}/status', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Status', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_outline_schema(self, schema_version, **kwargs): # noqa: E501
"""Story Outline Schema # noqa: E501
Json Schema for validating Story Outline objects # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_outline_schema(schema_version, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str schema_version: The semanitic version of a schema (e.g. '0.3.1') (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_outline_schema_with_http_info(schema_version, **kwargs) # noqa: E501
def story_outline_schema_with_http_info(self, schema_version, **kwargs): # noqa: E501
"""Story Outline Schema # noqa: E501
Json Schema for validating Story Outline objects # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_outline_schema_with_http_info(schema_version, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str schema_version: The semanitic version of a schema (e.g. '0.3.1') (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['schema_version'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_outline_schema" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'schema_version' is set
if ('schema_version' not in local_var_params or
local_var_params['schema_version'] is None):
raise ApiValueError("Missing the required parameter `schema_version` when calling `story_outline_schema`") # noqa: E501
collection_formats = {}
path_params = {}
if 'schema_version' in local_var_params:
path_params['schema_version'] = local_var_params['schema_version'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/outline-schema/{schema_version}/story-outline.json', 'GET',
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=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_permission_types_get(self, **kwargs): # noqa: E501
"""Permissions: List Permission Types # noqa: E501
Returns a list of possible user permission types # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_permission_types_get(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: list[PermissionType]
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_permission_types_get_with_http_info(**kwargs) # noqa: E501
def story_permission_types_get_with_http_info(self, **kwargs): # noqa: E501
"""Permissions: List Permission Types # noqa: E501
Returns a list of possible user permission types # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_permission_types_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(list[PermissionType], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
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')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_permission_types_get" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/permission_types', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[PermissionType]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_post(self, outline, **kwargs): # noqa: E501
"""Story: Upload # noqa: E501
Upload new story to presalytics 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.story_post(outline, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param Outline outline: A story outline json object (required)
:param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Story
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_post_with_http_info(outline, **kwargs) # noqa: E501
def story_post_with_http_info(self, outline, **kwargs): # noqa: E501
"""Story: Upload # noqa: E501
Upload new story to presalytics 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.story_post_with_http_info(outline, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param Outline outline: A story outline json object (required)
:param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Story, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['outline', 'include_outline'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_post" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'outline' is set
if ('outline' not in local_var_params or
local_var_params['outline'] is None):
raise ApiValueError("Missing the required parameter `outline` when calling `story_post`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'include_outline' in local_var_params:
query_params.append(('include_outline', local_var_params['include_outline'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'outline' in local_var_params:
body_params = local_var_params['outline']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Story', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_post_file(self, **kwargs): # noqa: E501
"""Story: Upload a File # noqa: E501
Upload new story to presalytics api via an Open Office Xml file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_post_file(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times.
:param list[file] file:
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Story
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_post_file_with_http_info(**kwargs) # noqa: E501
def story_post_file_with_http_info(self, **kwargs): # noqa: E501
"""Story: Upload a File # noqa: E501
Upload new story to presalytics api via an Open Office Xml file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_post_file_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times.
:param list[file] file:
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Story, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['include_outline', 'file'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_post_file" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'include_outline' in local_var_params:
query_params.append(('include_outline', local_var_params['include_outline'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
if 'file' in local_var_params:
local_var_files['file'] = local_var_params['file'] # noqa: E501
collection_formats['file'] = 'csv' # noqa: E501
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['multipart/form-data']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/file', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Story', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def story_post_file_json(self, **kwargs): # noqa: E501
"""Story: Upload a File (base64) # noqa: E501
Upload new story to presalytics api via an Open Office Xml file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_post_file_json(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times.
:param FileUpload file_upload: A json-formatted object that includes a base64 encoded file (file encoded utf-8)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Story
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.story_post_file_json_with_http_info(**kwargs) # noqa: E501
def story_post_file_json_with_http_info(self, **kwargs): # noqa: E501
"""Story: Upload a File (base64) # noqa: E501
Upload new story to presalytics api via an Open Office Xml file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_post_file_json_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times.
:param FileUpload file_upload: A json-formatted object that includes a base64 encoded file (file encoded utf-8)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Story, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['include_outline', 'file_upload'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method story_post_file_json" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'include_outline' in local_var_params:
query_params.append(('include_outline', local_var_params['include_outline'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'file_upload' in local_var_params:
body_params = local_var_params['file_upload']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/file/json', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Story', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def views_id_delete(self, view_id, **kwargs): # noqa: E501
"""Views: Delete by Id # noqa: E501
Remove a view and dependant data. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.views_id_delete(view_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str view_id: The primary key for a page view within a session (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.views_id_delete_with_http_info(view_id, **kwargs) # noqa: E501
def views_id_delete_with_http_info(self, view_id, **kwargs): # noqa: E501
"""Views: Delete by Id # noqa: E501
Remove a view and dependant data. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.views_id_delete_with_http_info(view_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str view_id: The primary key for a page view within a session (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['view_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')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method views_id_delete" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'view_id' is set
if ('view_id' not in local_var_params or
local_var_params['view_id'] is None):
raise ApiValueError("Missing the required parameter `view_id` when calling `views_id_delete`") # noqa: E501
collection_formats = {}
path_params = {}
if 'view_id' in local_var_params:
path_params['view_id'] = local_var_params['view_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/views/{view_id}', 'DELETE',
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=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def views_id_get(self, view_id, **kwargs): # noqa: E501
"""Views: Get View # noqa: E501
Get view meta data # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.views_id_get(view_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str view_id: The primary key for a page view within a session (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: View
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
return self.views_id_get_with_http_info(view_id, **kwargs) # noqa: E501
def views_id_get_with_http_info(self, view_id, **kwargs): # noqa: E501
"""Views: Get View # noqa: E501
Get view meta data # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.views_id_get_with_http_info(view_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str view_id: The primary key for a page view within a session (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(View, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['view_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')
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method views_id_get" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'view_id' is set
if ('view_id' not in local_var_params or
local_var_params['view_id'] is None):
raise ApiValueError("Missing the required parameter `view_id` when calling `views_id_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'view_id' in local_var_params:
path_params['view_id'] = local_var_params['view_id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/views/{view_id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='View', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)Classes
class DefaultApi (api_client=None)-
NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech
Do not edit the class manually.
Expand source code Browse git
class DefaultApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech Do not edit the class manually. """ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client def collaborators_post(self, collaborator_bulk_update_request, **kwargs): # noqa: E501 """Collborators: Bulk Update (Admin Only) # noqa: E501 Allows for bulk updates on collaborator metadata. Restricted to internal admins # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.collaborators_post(collaborator_bulk_update_request, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CollaboratorBulkUpdateRequest collaborator_bulk_update_request: parameters to identify an update a collaborator across multiple stories (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[PermissionType] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.collaborators_post_with_http_info(collaborator_bulk_update_request, **kwargs) # noqa: E501 def collaborators_post_with_http_info(self, collaborator_bulk_update_request, **kwargs): # noqa: E501 """Collborators: Bulk Update (Admin Only) # noqa: E501 Allows for bulk updates on collaborator metadata. Restricted to internal admins # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.collaborators_post_with_http_info(collaborator_bulk_update_request, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CollaboratorBulkUpdateRequest collaborator_bulk_update_request: parameters to identify an update a collaborator across multiple stories (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[PermissionType], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['collaborator_bulk_update_request'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method collaborators_post" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'collaborator_bulk_update_request' is set if ('collaborator_bulk_update_request' not in local_var_params or local_var_params['collaborator_bulk_update_request'] is None): raise ApiValueError("Missing the required parameter `collaborator_bulk_update_request` when calling `collaborators_post`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'collaborator_bulk_update_request' in local_var_params: body_params = local_var_params['collaborator_bulk_update_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/collaborators', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[PermissionType]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_environment(self, **kwargs): # noqa: E501 """Environment: Get # noqa: E501 pass rendering metadata to the client-side scripts # 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_environment(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: object If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_environment_with_http_info(**kwargs) # noqa: E501 def get_environment_with_http_info(self, **kwargs): # noqa: E501 """Environment: Get # noqa: E501 pass rendering metadata to the client-side scripts # 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_environment_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(object, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() 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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_environment" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/environment/', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='object', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def session_id_delete(self, session_id, **kwargs): # noqa: E501 """Sessions: Delete by Id # noqa: E501 Remove a session and dependant data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.session_id_delete(session_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.session_id_delete_with_http_info(session_id, **kwargs) # noqa: E501 def session_id_delete_with_http_info(self, session_id, **kwargs): # noqa: E501 """Sessions: Delete by Id # noqa: E501 Remove a session and dependant data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.session_id_delete_with_http_info(session_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['session_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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method session_id_delete" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'session_id' is set if ('session_id' not in local_var_params or local_var_params['session_id'] is None): raise ApiValueError("Missing the required parameter `session_id` when calling `session_id_delete`") # noqa: E501 collection_formats = {} path_params = {} if 'session_id' in local_var_params: path_params['session_id'] = local_var_params['session_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/sessions/{session_id}', 'DELETE', 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=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def session_id_get(self, session_id, **kwargs): # noqa: E501 """Sessions: Get # noqa: E501 Get session metadata # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.session_id_get(session_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param bool include_relationships: Indicate whether the returned object should include child relationships :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Session If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.session_id_get_with_http_info(session_id, **kwargs) # noqa: E501 def session_id_get_with_http_info(self, session_id, **kwargs): # noqa: E501 """Sessions: Get # noqa: E501 Get session metadata # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.session_id_get_with_http_info(session_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param bool include_relationships: Indicate whether the returned object should include child relationships :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Session, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['session_id', 'include_relationships'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method session_id_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'session_id' is set if ('session_id' not in local_var_params or local_var_params['session_id'] is None): raise ApiValueError("Missing the required parameter `session_id` when calling `session_id_get`") # noqa: E501 collection_formats = {} path_params = {} if 'session_id' in local_var_params: path_params['session_id'] = local_var_params['session_id'] # noqa: E501 query_params = [] if 'include_relationships' in local_var_params: query_params.append(('include_relationships', local_var_params['include_relationships'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/sessions/{session_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Session', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def sessions_id_views_get(self, session_id, **kwargs): # noqa: E501 """Views: List Session Views # noqa: E501 Get data for all views in a session # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.sessions_id_views_get(session_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[View] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.sessions_id_views_get_with_http_info(session_id, **kwargs) # noqa: E501 def sessions_id_views_get_with_http_info(self, session_id, **kwargs): # noqa: E501 """Views: List Session Views # noqa: E501 Get data for all views in a session # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.sessions_id_views_get_with_http_info(session_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[View], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['session_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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method sessions_id_views_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'session_id' is set if ('session_id' not in local_var_params or local_var_params['session_id'] is None): raise ApiValueError("Missing the required parameter `session_id` when calling `sessions_id_views_get`") # noqa: E501 collection_formats = {} path_params = {} if 'session_id' in local_var_params: path_params['session_id'] = local_var_params['session_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/sessions/{session_id}/views', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[View]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def sessions_id_views_post(self, session_id, required_parameters_to_create_a_view, **kwargs): # noqa: E501 """Views: Create A Session View # noqa: E501 Create a page view object for a viewing session # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.sessions_id_views_post(session_id, required_parameters_to_create_a_view, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param RequiredParametersToCreateAView required_parameters_to_create_a_view: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: View If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.sessions_id_views_post_with_http_info(session_id, required_parameters_to_create_a_view, **kwargs) # noqa: E501 def sessions_id_views_post_with_http_info(self, session_id, required_parameters_to_create_a_view, **kwargs): # noqa: E501 """Views: Create A Session View # noqa: E501 Create a page view object for a viewing session # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.sessions_id_views_post_with_http_info(session_id, required_parameters_to_create_a_view, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param RequiredParametersToCreateAView required_parameters_to_create_a_view: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(View, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['session_id', 'required_parameters_to_create_a_view'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method sessions_id_views_post" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'session_id' is set if ('session_id' not in local_var_params or local_var_params['session_id'] is None): raise ApiValueError("Missing the required parameter `session_id` when calling `sessions_id_views_post`") # noqa: E501 # verify the required parameter 'required_parameters_to_create_a_view' is set if ('required_parameters_to_create_a_view' not in local_var_params or local_var_params['required_parameters_to_create_a_view'] is None): raise ApiValueError("Missing the required parameter `required_parameters_to_create_a_view` when calling `sessions_id_views_post`") # noqa: E501 collection_formats = {} path_params = {} if 'session_id' in local_var_params: path_params['session_id'] = local_var_params['session_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'required_parameters_to_create_a_view' in local_var_params: body_params = local_var_params['required_parameters_to_create_a_view'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/sessions/{session_id}/views', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='View', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def spec_no_tags(self, **kwargs): # noqa: E501 """Specification: No tags # noqa: E501 json-formatted version of this spec with the tags removed to help with codegen processes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.spec_no_tags(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.spec_no_tags_with_http_info(**kwargs) # noqa: E501 def spec_no_tags_with_http_info(self, **kwargs): # noqa: E501 """Specification: No tags # noqa: E501 json-formatted version of this spec with the tags removed to help with codegen processes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.spec_no_tags_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() 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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method spec_no_tags" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/no_tags_spec', 'GET', 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=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_get(self, **kwargs): # noqa: E501 """Story: Get List of User Stories # noqa: E501 Returns a list of stories for this user identifie via the access token presentated to 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.story_get(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool include_relationships: Indicate whether the returned object should include child relationships :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[Story] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_get_with_http_info(**kwargs) # noqa: E501 def story_get_with_http_info(self, **kwargs): # noqa: E501 """Story: Get List of User Stories # noqa: E501 Returns a list of stories for this user identifie via the access token presentated to 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.story_get_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool include_relationships: Indicate whether the returned object should include child relationships :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[Story], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['include_relationships', 'include_outline'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'include_relationships' in local_var_params: query_params.append(('include_relationships', local_var_params['include_relationships'])) # noqa: E501 if 'include_outline' in local_var_params: query_params.append(('include_outline', local_var_params['include_outline'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # 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='list[Story]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_collaborators_get(self, id, **kwargs): # noqa: E501 """Story Collaborators: List # noqa: E501 Gets a list users that can read or edit this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_get(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[StoryCollaborator] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_collaborators_get_with_http_info(id, **kwargs) # noqa: E501 def story_id_collaborators_get_with_http_info(self, id, **kwargs): # noqa: E501 """Story Collaborators: List # noqa: E501 Gets a list users that can read or edit this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_get_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[StoryCollaborator], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_collaborators_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_collaborators_get`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/collaborators', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[StoryCollaborator]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_collaborators_inactive_post(self, id, modify_inactive_collaborator, **kwargs): # noqa: E501 """Story Collaborators: Edit Inactive User Permission # noqa: E501 Edit story permissions for inactive users. Requires admin rights. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_inactive_post(id, modify_inactive_collaborator, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param ModifyInactiveCollaborator modify_inactive_collaborator: Collaborator user id and permission type (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: StoryCollaborator If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_collaborators_inactive_post_with_http_info(id, modify_inactive_collaborator, **kwargs) # noqa: E501 def story_id_collaborators_inactive_post_with_http_info(self, id, modify_inactive_collaborator, **kwargs): # noqa: E501 """Story Collaborators: Edit Inactive User Permission # noqa: E501 Edit story permissions for inactive users. Requires admin rights. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_inactive_post_with_http_info(id, modify_inactive_collaborator, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param ModifyInactiveCollaborator modify_inactive_collaborator: Collaborator user id and permission type (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(StoryCollaborator, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'modify_inactive_collaborator'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_collaborators_inactive_post" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_collaborators_inactive_post`") # noqa: E501 # verify the required parameter 'modify_inactive_collaborator' is set if ('modify_inactive_collaborator' not in local_var_params or local_var_params['modify_inactive_collaborator'] is None): raise ApiValueError("Missing the required parameter `modify_inactive_collaborator` when calling `story_id_collaborators_inactive_post`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'modify_inactive_collaborator' in local_var_params: body_params = local_var_params['modify_inactive_collaborator'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/collaborators/inactive', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='StoryCollaborator', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_collaborators_post(self, id, add_new_collaborator_request, **kwargs): # noqa: E501 """Story Collaborators: Add New User # noqa: E501 Add a colloborator to this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_post(id, add_new_collaborator_request, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param AddNewCollaboratorRequest add_new_collaborator_request: Collaborator user id and permission type (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: StoryCollaborator If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_collaborators_post_with_http_info(id, add_new_collaborator_request, **kwargs) # noqa: E501 def story_id_collaborators_post_with_http_info(self, id, add_new_collaborator_request, **kwargs): # noqa: E501 """Story Collaborators: Add New User # noqa: E501 Add a colloborator to this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_post_with_http_info(id, add_new_collaborator_request, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param AddNewCollaboratorRequest add_new_collaborator_request: Collaborator user id and permission type (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(StoryCollaborator, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'add_new_collaborator_request'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_collaborators_post" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_collaborators_post`") # noqa: E501 # verify the required parameter 'add_new_collaborator_request' is set if ('add_new_collaborator_request' not in local_var_params or local_var_params['add_new_collaborator_request'] is None): raise ApiValueError("Missing the required parameter `add_new_collaborator_request` when calling `story_id_collaborators_post`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'add_new_collaborator_request' in local_var_params: body_params = local_var_params['add_new_collaborator_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/collaborators', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='StoryCollaborator', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_collaborators_userid_delete(self, id, story_collaborator_userid, **kwargs): # noqa: E501 """Story Collaborators: Remove User # noqa: E501 Remove a collaborator from this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_userid_delete(id, story_collaborator_userid, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_collaborators_userid_delete_with_http_info(id, story_collaborator_userid, **kwargs) # noqa: E501 def story_id_collaborators_userid_delete_with_http_info(self, id, story_collaborator_userid, **kwargs): # noqa: E501 """Story Collaborators: Remove User # noqa: E501 Remove a collaborator from this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_userid_delete_with_http_info(id, story_collaborator_userid, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'story_collaborator_userid'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_collaborators_userid_delete" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_collaborators_userid_delete`") # noqa: E501 # verify the required parameter 'story_collaborator_userid' is set if ('story_collaborator_userid' not in local_var_params or local_var_params['story_collaborator_userid'] is None): raise ApiValueError("Missing the required parameter `story_collaborator_userid` when calling `story_id_collaborators_userid_delete`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 if 'story_collaborator_userid' in local_var_params: path_params['story_collaborator_userid'] = local_var_params['story_collaborator_userid'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/collaborators/{story_collaborator_userid}', 'DELETE', 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=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_collaborators_userid_get(self, id, story_collaborator_userid, **kwargs): # noqa: E501 """Story Collaborators: Access Permissions # noqa: E501 Data to help you understand the access rights of a particular collaborator on this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_userid_get(id, story_collaborator_userid, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: StoryCollaborator If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_collaborators_userid_get_with_http_info(id, story_collaborator_userid, **kwargs) # noqa: E501 def story_id_collaborators_userid_get_with_http_info(self, id, story_collaborator_userid, **kwargs): # noqa: E501 """Story Collaborators: Access Permissions # noqa: E501 Data to help you understand the access rights of a particular collaborator on this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_userid_get_with_http_info(id, story_collaborator_userid, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(StoryCollaborator, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'story_collaborator_userid'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_collaborators_userid_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_collaborators_userid_get`") # noqa: E501 # verify the required parameter 'story_collaborator_userid' is set if ('story_collaborator_userid' not in local_var_params or local_var_params['story_collaborator_userid'] is None): raise ApiValueError("Missing the required parameter `story_collaborator_userid` when calling `story_id_collaborators_userid_get`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 if 'story_collaborator_userid' in local_var_params: path_params['story_collaborator_userid'] = local_var_params['story_collaborator_userid'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/collaborators/{story_collaborator_userid}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='StoryCollaborator', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_collaborators_userid_permissiontype_get(self, id, story_collaborator_userid, permissiontype, **kwargs): # noqa: E501 """Permissions: Story Authorization for a User # noqa: E501 Check whether user have certain types of permissions. Use http status codes to understand if permission is granted - 204 = Granted, 403 = Forbidden # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_userid_permissiontype_get(id, story_collaborator_userid, permissiontype, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param str permissiontype: the type of permission requested. can be a permission_type object name (e.g., owner, editor, create, viewer, admin) or a permission type field (e.g., can_edit, can_view, can_add_collaborators, can_delete) (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_collaborators_userid_permissiontype_get_with_http_info(id, story_collaborator_userid, permissiontype, **kwargs) # noqa: E501 def story_id_collaborators_userid_permissiontype_get_with_http_info(self, id, story_collaborator_userid, permissiontype, **kwargs): # noqa: E501 """Permissions: Story Authorization for a User # noqa: E501 Check whether user have certain types of permissions. Use http status codes to understand if permission is granted - 204 = Granted, 403 = Forbidden # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_userid_permissiontype_get_with_http_info(id, story_collaborator_userid, permissiontype, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param str permissiontype: the type of permission requested. can be a permission_type object name (e.g., owner, editor, create, viewer, admin) or a permission type field (e.g., can_edit, can_view, can_add_collaborators, can_delete) (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'story_collaborator_userid', 'permissiontype'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_collaborators_userid_permissiontype_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_collaborators_userid_permissiontype_get`") # noqa: E501 # verify the required parameter 'story_collaborator_userid' is set if ('story_collaborator_userid' not in local_var_params or local_var_params['story_collaborator_userid'] is None): raise ApiValueError("Missing the required parameter `story_collaborator_userid` when calling `story_id_collaborators_userid_permissiontype_get`") # noqa: E501 # verify the required parameter 'permissiontype' is set if ('permissiontype' not in local_var_params or local_var_params['permissiontype'] is None): raise ApiValueError("Missing the required parameter `permissiontype` when calling `story_id_collaborators_userid_permissiontype_get`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 if 'story_collaborator_userid' in local_var_params: path_params['story_collaborator_userid'] = local_var_params['story_collaborator_userid'] # noqa: E501 if 'permissiontype' in local_var_params: path_params['permissiontype'] = local_var_params['permissiontype'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/collaborators/authorize/{story_collaborator_userid}/{permissiontype}', 'GET', 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=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_collaborators_userid_put(self, id, story_collaborator_userid, story_collaborator, **kwargs): # noqa: E501 """Story Collaborators: Edit Access Rights # noqa: E501 Modify a user's access right to this story (e.g., grant edit permissions) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_userid_put(id, story_collaborator_userid, story_collaborator, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param StoryCollaborator story_collaborator: Collaborator user id (presalytics userid) and permission type (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: StoryCollaborator If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_collaborators_userid_put_with_http_info(id, story_collaborator_userid, story_collaborator, **kwargs) # noqa: E501 def story_id_collaborators_userid_put_with_http_info(self, id, story_collaborator_userid, story_collaborator, **kwargs): # noqa: E501 """Story Collaborators: Edit Access Rights # noqa: E501 Modify a user's access right to this story (e.g., grant edit permissions) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_userid_put_with_http_info(id, story_collaborator_userid, story_collaborator, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param StoryCollaborator story_collaborator: Collaborator user id (presalytics userid) and permission type (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(StoryCollaborator, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'story_collaborator_userid', 'story_collaborator'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_collaborators_userid_put" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_collaborators_userid_put`") # noqa: E501 # verify the required parameter 'story_collaborator_userid' is set if ('story_collaborator_userid' not in local_var_params or local_var_params['story_collaborator_userid'] is None): raise ApiValueError("Missing the required parameter `story_collaborator_userid` when calling `story_id_collaborators_userid_put`") # noqa: E501 # verify the required parameter 'story_collaborator' is set if ('story_collaborator' not in local_var_params or local_var_params['story_collaborator'] is None): raise ApiValueError("Missing the required parameter `story_collaborator` when calling `story_id_collaborators_userid_put`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 if 'story_collaborator_userid' in local_var_params: path_params['story_collaborator_userid'] = local_var_params['story_collaborator_userid'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'story_collaborator' in local_var_params: body_params = local_var_params['story_collaborator'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/collaborators/{story_collaborator_userid}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='StoryCollaborator', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_d3_id_get(self, id, d3_id, **kwargs): # noqa: E501 """Story: Get D3 Iframe # noqa: E501 Gets a barebones html document with objects redender by d3 script with a Restrictive Content-Security-Policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_d3_id_get(id, d3_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str d3_id: A d3 figure id from a D3Widget instance in the Presaltyics Python Library (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_d3_id_get_with_http_info(id, d3_id, **kwargs) # noqa: E501 def story_id_d3_id_get_with_http_info(self, id, d3_id, **kwargs): # noqa: E501 """Story: Get D3 Iframe # noqa: E501 Gets a barebones html document with objects redender by d3 script with a Restrictive Content-Security-Policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_d3_id_get_with_http_info(id, d3_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str d3_id: A d3 figure id from a D3Widget instance in the Presaltyics Python Library (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'd3_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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_d3_id_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_d3_id_get`") # noqa: E501 # verify the required parameter 'd3_id' is set if ('d3_id' not in local_var_params or local_var_params['d3_id'] is None): raise ApiValueError("Missing the required parameter `d3_id` when calling `story_id_d3_id_get`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 if 'd3_id' in local_var_params: path_params['d3_id'] = local_var_params['d3_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( ['text/html']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/d3/{d3_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='str', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_delete(self, id, **kwargs): # noqa: E501 """Story: Delete by Id # noqa: E501 Remove a story and dependant data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_delete(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_delete_with_http_info(id, **kwargs) # noqa: E501 def story_id_delete_with_http_info(self, id, **kwargs): # noqa: E501 """Story: Delete by Id # noqa: E501 Remove a story and dependant data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_delete_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_delete" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_delete`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}', 'DELETE', 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=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_file_ooxmlautomationid_get(self, id, ooxml_automation_id, **kwargs): # noqa: E501 """Story: Download Updated File # noqa: E501 Redtreives updated story as open office xml file (e.g., .pptx, .docx, .xlsx) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_file_ooxmlautomationid_get(id, ooxml_automation_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str ooxml_automation_id: the id of the ooxml_automation object (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_file_ooxmlautomationid_get_with_http_info(id, ooxml_automation_id, **kwargs) # noqa: E501 def story_id_file_ooxmlautomationid_get_with_http_info(self, id, ooxml_automation_id, **kwargs): # noqa: E501 """Story: Download Updated File # noqa: E501 Redtreives updated story as open office xml file (e.g., .pptx, .docx, .xlsx) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_file_ooxmlautomationid_get_with_http_info(id, ooxml_automation_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str ooxml_automation_id: the id of the ooxml_automation object (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(file, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'ooxml_automation_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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_file_ooxmlautomationid_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_file_ooxmlautomationid_get`") # noqa: E501 # verify the required parameter 'ooxml_automation_id' is set if ('ooxml_automation_id' not in local_var_params or local_var_params['ooxml_automation_id'] is None): raise ApiValueError("Missing the required parameter `ooxml_automation_id` when calling `story_id_file_ooxmlautomationid_get`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 if 'ooxml_automation_id' in local_var_params: path_params['ooxml_automation_id'] = local_var_params['ooxml_automation_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/vnd.openxmlformats-officedocument.presentationml.presentation', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/file/{ooxml_automation_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='file', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_file_post(self, id, **kwargs): # noqa: E501 """Story: Upload a File To Existing Story # noqa: E501 Upload a file to an existing story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_file_post(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param bool replace_existing: Indicates whether a put or post method would replace the existing contents :param str obsolete_id: A primary key pointing to an obsolete item in the story. Item type is context-dependent :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param list[file] file: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Story If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_file_post_with_http_info(id, **kwargs) # noqa: E501 def story_id_file_post_with_http_info(self, id, **kwargs): # noqa: E501 """Story: Upload a File To Existing Story # noqa: E501 Upload a file to an existing story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_file_post_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param bool replace_existing: Indicates whether a put or post method would replace the existing contents :param str obsolete_id: A primary key pointing to an obsolete item in the story. Item type is context-dependent :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param list[file] file: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Story, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'replace_existing', 'obsolete_id', 'include_outline', 'file'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_file_post" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_file_post`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] if 'replace_existing' in local_var_params: query_params.append(('replace_existing', local_var_params['replace_existing'])) # noqa: E501 if 'obsolete_id' in local_var_params: query_params.append(('obsolete_id', local_var_params['obsolete_id'])) # noqa: E501 if 'include_outline' in local_var_params: query_params.append(('include_outline', local_var_params['include_outline'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} if 'file' in local_var_params: local_var_files['file'] = local_var_params['file'] # noqa: E501 collection_formats['file'] = 'csv' # noqa: E501 body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['multipart/form-data']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/file', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Story', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_get(self, id, **kwargs): # noqa: E501 """Story: Get by Id # noqa: E501 Returns story metadata, inlcuding json object with story outline # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_get(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param bool include_relationships: Indicate whether the returned object should include child relationships :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param bool full: Pull a story object with associated collaborator user, permission, and session data(faster if cached from prior api call) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Story If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_get_with_http_info(id, **kwargs) # noqa: E501 def story_id_get_with_http_info(self, id, **kwargs): # noqa: E501 """Story: Get by Id # noqa: E501 Returns story metadata, inlcuding json object with story outline # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_get_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param bool include_relationships: Indicate whether the returned object should include child relationships :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param bool full: Pull a story object with associated collaborator user, permission, and session data(faster if cached from prior api call) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Story, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'include_relationships', 'include_outline', 'full'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_get`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] if 'include_relationships' in local_var_params: query_params.append(('include_relationships', local_var_params['include_relationships'])) # noqa: E501 if 'include_outline' in local_var_params: query_params.append(('include_outline', local_var_params['include_outline'])) # noqa: E501 if 'full' in local_var_params: query_params.append(('full', local_var_params['full'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Story', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_maplotlib_responsive_figure_id_get(self, id, figure_id, **kwargs): # noqa: E501 """Story: Get Matplotlib Iframe # noqa: E501 Gets a barebones html document with a matplotlib chart. Useful for rendering inside responsive iframes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_maplotlib_responsive_figure_id_get(id, figure_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str figure_id: A matplotlib figure id from a MatplotlibResponsiveFigure instance in the Presaltyics Python Library (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_maplotlib_responsive_figure_id_get_with_http_info(id, figure_id, **kwargs) # noqa: E501 def story_id_maplotlib_responsive_figure_id_get_with_http_info(self, id, figure_id, **kwargs): # noqa: E501 """Story: Get Matplotlib Iframe # noqa: E501 Gets a barebones html document with a matplotlib chart. Useful for rendering inside responsive iframes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_maplotlib_responsive_figure_id_get_with_http_info(id, figure_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str figure_id: A matplotlib figure id from a MatplotlibResponsiveFigure instance in the Presaltyics Python Library (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'figure_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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_maplotlib_responsive_figure_id_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_maplotlib_responsive_figure_id_get`") # noqa: E501 # verify the required parameter 'figure_id' is set if ('figure_id' not in local_var_params or local_var_params['figure_id'] is None): raise ApiValueError("Missing the required parameter `figure_id` when calling `story_id_maplotlib_responsive_figure_id_get`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 if 'figure_id' in local_var_params: path_params['figure_id'] = local_var_params['figure_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( ['text/html']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/matplotlib-responsive/{figure_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='str', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_outline_get(self, id, **kwargs): # noqa: E501 """Story: Get Story Outline # noqa: E501 Returns Story's outline # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_outline_get(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_outline_get_with_http_info(id, **kwargs) # noqa: E501 def story_id_outline_get_with_http_info(self, id, **kwargs): # noqa: E501 """Story: Get Story Outline # noqa: E501 Returns Story's outline # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_outline_get_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_outline_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_outline_get`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/outline', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='str', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_outline_post(self, id, body, **kwargs): # noqa: E501 """Story: Post Story Outline # noqa: E501 Update a story outline. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_outline_post(id, body, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str body: A story outline object (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_outline_post_with_http_info(id, body, **kwargs) # noqa: E501 def story_id_outline_post_with_http_info(self, id, body, **kwargs): # noqa: E501 """Story: Post Story Outline # noqa: E501 Update a story outline. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_outline_post_with_http_info(id, body, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str body: A story outline object (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_outline_post" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_outline_post`") # noqa: E501 # verify the required parameter 'body' is set if ('body' not in local_var_params or local_var_params['body'] is None): raise ApiValueError("Missing the required parameter `body` when calling `story_id_outline_post`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'body' in local_var_params: body_params = local_var_params['body'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/outline', '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=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_put(self, id, story, **kwargs): # noqa: E501 """Story: Modify # noqa: E501 Update story metadata, including story outline # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_put(id, story, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param Story story: The updated story object (required) :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Story If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_put_with_http_info(id, story, **kwargs) # noqa: E501 def story_id_put_with_http_info(self, id, story, **kwargs): # noqa: E501 """Story: Modify # noqa: E501 Update story metadata, including story outline # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_put_with_http_info(id, story, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param Story story: The updated story object (required) :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Story, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'story', 'include_outline'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_put" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_put`") # noqa: E501 # verify the required parameter 'story' is set if ('story' not in local_var_params or local_var_params['story'] is None): raise ApiValueError("Missing the required parameter `story` when calling `story_id_put`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] if 'include_outline' in local_var_params: query_params.append(('include_outline', local_var_params['include_outline'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None if 'story' in local_var_params: body_params = local_var_params['story'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Story', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_reveal(self, id, **kwargs): # noqa: E501 """Story: Get Story at Reveal.js Document # noqa: E501 returns an html document containing a reveal.js epresentation of the story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_reveal(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_reveal_with_http_info(id, **kwargs) # noqa: E501 def story_id_reveal_with_http_info(self, id, **kwargs): # noqa: E501 """Story: Get Story at Reveal.js Document # noqa: E501 returns an html document containing a reveal.js epresentation of the story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_reveal_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_reveal" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_reveal`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['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', 'text/html']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/reveal', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='str', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_session_post(self, id, create_session_request, **kwargs): # noqa: E501 """Sessions: Create a Session # noqa: E501 Create a new session # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_session_post(id, create_session_request, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param CreateSessionRequest create_session_request: Collaborator user id and permission type (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Session If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_session_post_with_http_info(id, create_session_request, **kwargs) # noqa: E501 def story_id_session_post_with_http_info(self, id, create_session_request, **kwargs): # noqa: E501 """Sessions: Create a Session # noqa: E501 Create a new session # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_session_post_with_http_info(id, create_session_request, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param CreateSessionRequest create_session_request: Collaborator user id and permission type (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Session, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'create_session_request'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_session_post" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_session_post`") # noqa: E501 # verify the required parameter 'create_session_request' is set if ('create_session_request' not in local_var_params or local_var_params['create_session_request'] is None): raise ApiValueError("Missing the required parameter `create_session_request` when calling `story_id_session_post`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_session_request' in local_var_params: body_params = local_var_params['create_session_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/sessions', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Session', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_sessions_get(self, id, **kwargs): # noqa: E501 """Sessions: List Story Sessions # noqa: E501 Get a list of sessions asscoaited with this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_sessions_get(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param bool include_relationships: Indicate whether the returned object should include child relationships :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[Session] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_sessions_get_with_http_info(id, **kwargs) # noqa: E501 def story_id_sessions_get_with_http_info(self, id, **kwargs): # noqa: E501 """Sessions: List Story Sessions # noqa: E501 Get a list of sessions asscoaited with this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_sessions_get_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param bool include_relationships: Indicate whether the returned object should include child relationships :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[Session], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'include_relationships'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_sessions_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_sessions_get`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] if 'include_relationships' in local_var_params: query_params.append(('include_relationships', local_var_params['include_relationships'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/sessions', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[Session]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_status_get(self, id, **kwargs): # noqa: E501 """Story: Get Story Status # noqa: E501 Returns code indicating whether story has active running background and is healthy (e.g., the latest outline is valid) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_status_get(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Status If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_status_get_with_http_info(id, **kwargs) # noqa: E501 def story_id_status_get_with_http_info(self, id, **kwargs): # noqa: E501 """Story: Get Story Status # noqa: E501 Returns code indicating whether story has active running background and is healthy (e.g., the latest outline is valid) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_status_get_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Status, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_status_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_status_get`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/status', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Status', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_outline_schema(self, schema_version, **kwargs): # noqa: E501 """Story Outline Schema # noqa: E501 Json Schema for validating Story Outline objects # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_outline_schema(schema_version, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str schema_version: The semanitic version of a schema (e.g. '0.3.1') (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_outline_schema_with_http_info(schema_version, **kwargs) # noqa: E501 def story_outline_schema_with_http_info(self, schema_version, **kwargs): # noqa: E501 """Story Outline Schema # noqa: E501 Json Schema for validating Story Outline objects # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_outline_schema_with_http_info(schema_version, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str schema_version: The semanitic version of a schema (e.g. '0.3.1') (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['schema_version'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_outline_schema" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'schema_version' is set if ('schema_version' not in local_var_params or local_var_params['schema_version'] is None): raise ApiValueError("Missing the required parameter `schema_version` when calling `story_outline_schema`") # noqa: E501 collection_formats = {} path_params = {} if 'schema_version' in local_var_params: path_params['schema_version'] = local_var_params['schema_version'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/outline-schema/{schema_version}/story-outline.json', 'GET', 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=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_permission_types_get(self, **kwargs): # noqa: E501 """Permissions: List Permission Types # noqa: E501 Returns a list of possible user permission types # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_permission_types_get(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[PermissionType] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_permission_types_get_with_http_info(**kwargs) # noqa: E501 def story_permission_types_get_with_http_info(self, **kwargs): # noqa: E501 """Permissions: List Permission Types # noqa: E501 Returns a list of possible user permission types # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_permission_types_get_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[PermissionType], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() 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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_permission_types_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/permission_types', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[PermissionType]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_post(self, outline, **kwargs): # noqa: E501 """Story: Upload # noqa: E501 Upload new story to presalytics 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.story_post(outline, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param Outline outline: A story outline json object (required) :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Story If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_post_with_http_info(outline, **kwargs) # noqa: E501 def story_post_with_http_info(self, outline, **kwargs): # noqa: E501 """Story: Upload # noqa: E501 Upload new story to presalytics 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.story_post_with_http_info(outline, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param Outline outline: A story outline json object (required) :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Story, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['outline', 'include_outline'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_post" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'outline' is set if ('outline' not in local_var_params or local_var_params['outline'] is None): raise ApiValueError("Missing the required parameter `outline` when calling `story_post`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'include_outline' in local_var_params: query_params.append(('include_outline', local_var_params['include_outline'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None if 'outline' in local_var_params: body_params = local_var_params['outline'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Story', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_post_file(self, **kwargs): # noqa: E501 """Story: Upload a File # noqa: E501 Upload new story to presalytics api via an Open Office Xml file # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_post_file(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param list[file] file: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Story If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_post_file_with_http_info(**kwargs) # noqa: E501 def story_post_file_with_http_info(self, **kwargs): # noqa: E501 """Story: Upload a File # noqa: E501 Upload new story to presalytics api via an Open Office Xml file # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_post_file_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param list[file] file: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Story, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['include_outline', 'file'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_post_file" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'include_outline' in local_var_params: query_params.append(('include_outline', local_var_params['include_outline'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} if 'file' in local_var_params: local_var_files['file'] = local_var_params['file'] # noqa: E501 collection_formats['file'] = 'csv' # noqa: E501 body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['multipart/form-data']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/file', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Story', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_post_file_json(self, **kwargs): # noqa: E501 """Story: Upload a File (base64) # noqa: E501 Upload new story to presalytics api via an Open Office Xml file # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_post_file_json(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param FileUpload file_upload: A json-formatted object that includes a base64 encoded file (file encoded utf-8) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Story If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_post_file_json_with_http_info(**kwargs) # noqa: E501 def story_post_file_json_with_http_info(self, **kwargs): # noqa: E501 """Story: Upload a File (base64) # noqa: E501 Upload new story to presalytics api via an Open Office Xml file # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_post_file_json_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param FileUpload file_upload: A json-formatted object that includes a base64 encoded file (file encoded utf-8) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Story, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['include_outline', 'file_upload'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_post_file_json" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'include_outline' in local_var_params: query_params.append(('include_outline', local_var_params['include_outline'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None if 'file_upload' in local_var_params: body_params = local_var_params['file_upload'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/file/json', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Story', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def views_id_delete(self, view_id, **kwargs): # noqa: E501 """Views: Delete by Id # noqa: E501 Remove a view and dependant data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.views_id_delete(view_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str view_id: The primary key for a page view within a session (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.views_id_delete_with_http_info(view_id, **kwargs) # noqa: E501 def views_id_delete_with_http_info(self, view_id, **kwargs): # noqa: E501 """Views: Delete by Id # noqa: E501 Remove a view and dependant data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.views_id_delete_with_http_info(view_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str view_id: The primary key for a page view within a session (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['view_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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method views_id_delete" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'view_id' is set if ('view_id' not in local_var_params or local_var_params['view_id'] is None): raise ApiValueError("Missing the required parameter `view_id` when calling `views_id_delete`") # noqa: E501 collection_formats = {} path_params = {} if 'view_id' in local_var_params: path_params['view_id'] = local_var_params['view_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/views/{view_id}', 'DELETE', 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=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def views_id_get(self, view_id, **kwargs): # noqa: E501 """Views: Get View # noqa: E501 Get view meta data # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.views_id_get(view_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str view_id: The primary key for a page view within a session (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: View If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.views_id_get_with_http_info(view_id, **kwargs) # noqa: E501 def views_id_get_with_http_info(self, view_id, **kwargs): # noqa: E501 """Views: Get View # noqa: E501 Get view meta data # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.views_id_get_with_http_info(view_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str view_id: The primary key for a page view within a session (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(View, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['view_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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method views_id_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'view_id' is set if ('view_id' not in local_var_params or local_var_params['view_id'] is None): raise ApiValueError("Missing the required parameter `view_id` when calling `views_id_get`") # noqa: E501 collection_formats = {} path_params = {} if 'view_id' in local_var_params: path_params['view_id'] = local_var_params['view_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/views/{view_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='View', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)Methods
def collaborators_post(self, collaborator_bulk_update_request, **kwargs)-
Collborators: Bulk Update (Admin Only) # noqa: E501
Allows for bulk updates on collaborator metadata. Restricted to internal admins # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.collaborators_post(collaborator_bulk_update_request, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CollaboratorBulkUpdateRequest collaborator_bulk_update_request: parameters to identify an update a collaborator across multiple stories (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[PermissionType] If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def collaborators_post(self, collaborator_bulk_update_request, **kwargs): # noqa: E501 """Collborators: Bulk Update (Admin Only) # noqa: E501 Allows for bulk updates on collaborator metadata. Restricted to internal admins # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.collaborators_post(collaborator_bulk_update_request, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CollaboratorBulkUpdateRequest collaborator_bulk_update_request: parameters to identify an update a collaborator across multiple stories (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[PermissionType] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.collaborators_post_with_http_info(collaborator_bulk_update_request, **kwargs) # noqa: E501 def collaborators_post_with_http_info(self, collaborator_bulk_update_request, **kwargs)-
Collborators: Bulk Update (Admin Only) # noqa: E501
Allows for bulk updates on collaborator metadata. Restricted to internal admins # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.collaborators_post_with_http_info(collaborator_bulk_update_request, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CollaboratorBulkUpdateRequest collaborator_bulk_update_request: parameters to identify an update a collaborator across multiple stories (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[PermissionType], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def collaborators_post_with_http_info(self, collaborator_bulk_update_request, **kwargs): # noqa: E501 """Collborators: Bulk Update (Admin Only) # noqa: E501 Allows for bulk updates on collaborator metadata. Restricted to internal admins # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.collaborators_post_with_http_info(collaborator_bulk_update_request, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CollaboratorBulkUpdateRequest collaborator_bulk_update_request: parameters to identify an update a collaborator across multiple stories (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[PermissionType], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['collaborator_bulk_update_request'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method collaborators_post" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'collaborator_bulk_update_request' is set if ('collaborator_bulk_update_request' not in local_var_params or local_var_params['collaborator_bulk_update_request'] is None): raise ApiValueError("Missing the required parameter `collaborator_bulk_update_request` when calling `collaborators_post`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'collaborator_bulk_update_request' in local_var_params: body_params = local_var_params['collaborator_bulk_update_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/collaborators', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[PermissionType]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def get_environment(self, **kwargs)-
Environment: Get # noqa: E501
pass rendering metadata to the client-side scripts # 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_environment(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: object If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def get_environment(self, **kwargs): # noqa: E501 """Environment: Get # noqa: E501 pass rendering metadata to the client-side scripts # 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_environment(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: object If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_environment_with_http_info(**kwargs) # noqa: E501 def get_environment_with_http_info(self, **kwargs)-
Environment: Get # noqa: E501
pass rendering metadata to the client-side scripts # 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_environment_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(object, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def get_environment_with_http_info(self, **kwargs): # noqa: E501 """Environment: Get # noqa: E501 pass rendering metadata to the client-side scripts # 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_environment_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(object, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() 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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_environment" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/environment/', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='object', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def session_id_delete(self, session_id, **kwargs)-
Sessions: Delete by Id # noqa: E501
Remove a session and dependant data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.session_id_delete(session_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def session_id_delete(self, session_id, **kwargs): # noqa: E501 """Sessions: Delete by Id # noqa: E501 Remove a session and dependant data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.session_id_delete(session_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.session_id_delete_with_http_info(session_id, **kwargs) # noqa: E501 def session_id_delete_with_http_info(self, session_id, **kwargs)-
Sessions: Delete by Id # noqa: E501
Remove a session and dependant data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.session_id_delete_with_http_info(session_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def session_id_delete_with_http_info(self, session_id, **kwargs): # noqa: E501 """Sessions: Delete by Id # noqa: E501 Remove a session and dependant data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.session_id_delete_with_http_info(session_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['session_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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method session_id_delete" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'session_id' is set if ('session_id' not in local_var_params or local_var_params['session_id'] is None): raise ApiValueError("Missing the required parameter `session_id` when calling `session_id_delete`") # noqa: E501 collection_formats = {} path_params = {} if 'session_id' in local_var_params: path_params['session_id'] = local_var_params['session_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/sessions/{session_id}', 'DELETE', 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=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def session_id_get(self, session_id, **kwargs)-
Sessions: Get # noqa: E501
Get session metadata # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.session_id_get(session_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param bool include_relationships: Indicate whether the returned object should include child relationships :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Session If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def session_id_get(self, session_id, **kwargs): # noqa: E501 """Sessions: Get # noqa: E501 Get session metadata # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.session_id_get(session_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param bool include_relationships: Indicate whether the returned object should include child relationships :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Session If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.session_id_get_with_http_info(session_id, **kwargs) # noqa: E501 def session_id_get_with_http_info(self, session_id, **kwargs)-
Sessions: Get # noqa: E501
Get session metadata # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.session_id_get_with_http_info(session_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param bool include_relationships: Indicate whether the returned object should include child relationships :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Session, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def session_id_get_with_http_info(self, session_id, **kwargs): # noqa: E501 """Sessions: Get # noqa: E501 Get session metadata # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.session_id_get_with_http_info(session_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param bool include_relationships: Indicate whether the returned object should include child relationships :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Session, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['session_id', 'include_relationships'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method session_id_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'session_id' is set if ('session_id' not in local_var_params or local_var_params['session_id'] is None): raise ApiValueError("Missing the required parameter `session_id` when calling `session_id_get`") # noqa: E501 collection_formats = {} path_params = {} if 'session_id' in local_var_params: path_params['session_id'] = local_var_params['session_id'] # noqa: E501 query_params = [] if 'include_relationships' in local_var_params: query_params.append(('include_relationships', local_var_params['include_relationships'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/sessions/{session_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Session', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def sessions_id_views_get(self, session_id, **kwargs)-
Views: List Session Views # noqa: E501
Get data for all views in a session # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.sessions_id_views_get(session_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[View] If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def sessions_id_views_get(self, session_id, **kwargs): # noqa: E501 """Views: List Session Views # noqa: E501 Get data for all views in a session # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.sessions_id_views_get(session_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[View] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.sessions_id_views_get_with_http_info(session_id, **kwargs) # noqa: E501 def sessions_id_views_get_with_http_info(self, session_id, **kwargs)-
Views: List Session Views # noqa: E501
Get data for all views in a session # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.sessions_id_views_get_with_http_info(session_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[View], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def sessions_id_views_get_with_http_info(self, session_id, **kwargs): # noqa: E501 """Views: List Session Views # noqa: E501 Get data for all views in a session # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.sessions_id_views_get_with_http_info(session_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[View], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['session_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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method sessions_id_views_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'session_id' is set if ('session_id' not in local_var_params or local_var_params['session_id'] is None): raise ApiValueError("Missing the required parameter `session_id` when calling `sessions_id_views_get`") # noqa: E501 collection_formats = {} path_params = {} if 'session_id' in local_var_params: path_params['session_id'] = local_var_params['session_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/sessions/{session_id}/views', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[View]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def sessions_id_views_post(self, session_id, required_parameters_to_create_a_view, **kwargs)-
Views: Create A Session View # noqa: E501
Create a page view object for a viewing session # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.sessions_id_views_post(session_id, required_parameters_to_create_a_view, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param RequiredParametersToCreateAView required_parameters_to_create_a_view: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: View If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def sessions_id_views_post(self, session_id, required_parameters_to_create_a_view, **kwargs): # noqa: E501 """Views: Create A Session View # noqa: E501 Create a page view object for a viewing session # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.sessions_id_views_post(session_id, required_parameters_to_create_a_view, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param RequiredParametersToCreateAView required_parameters_to_create_a_view: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: View If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.sessions_id_views_post_with_http_info(session_id, required_parameters_to_create_a_view, **kwargs) # noqa: E501 def sessions_id_views_post_with_http_info(self, session_id, required_parameters_to_create_a_view, **kwargs)-
Views: Create A Session View # noqa: E501
Create a page view object for a viewing session # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.sessions_id_views_post_with_http_info(session_id, required_parameters_to_create_a_view, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param RequiredParametersToCreateAView required_parameters_to_create_a_view: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(View, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def sessions_id_views_post_with_http_info(self, session_id, required_parameters_to_create_a_view, **kwargs): # noqa: E501 """Views: Create A Session View # noqa: E501 Create a page view object for a viewing session # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.sessions_id_views_post_with_http_info(session_id, required_parameters_to_create_a_view, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str session_id: The primary key for a view session (required) :param RequiredParametersToCreateAView required_parameters_to_create_a_view: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(View, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['session_id', 'required_parameters_to_create_a_view'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method sessions_id_views_post" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'session_id' is set if ('session_id' not in local_var_params or local_var_params['session_id'] is None): raise ApiValueError("Missing the required parameter `session_id` when calling `sessions_id_views_post`") # noqa: E501 # verify the required parameter 'required_parameters_to_create_a_view' is set if ('required_parameters_to_create_a_view' not in local_var_params or local_var_params['required_parameters_to_create_a_view'] is None): raise ApiValueError("Missing the required parameter `required_parameters_to_create_a_view` when calling `sessions_id_views_post`") # noqa: E501 collection_formats = {} path_params = {} if 'session_id' in local_var_params: path_params['session_id'] = local_var_params['session_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'required_parameters_to_create_a_view' in local_var_params: body_params = local_var_params['required_parameters_to_create_a_view'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/sessions/{session_id}/views', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='View', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) -
Specification: No tags # noqa: E501
json-formatted version of this spec with the tags removed to help with codegen processes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.spec_no_tags(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def spec_no_tags(self, **kwargs): # noqa: E501 """Specification: No tags # noqa: E501 json-formatted version of this spec with the tags removed to help with codegen processes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.spec_no_tags(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.spec_no_tags_with_http_info(**kwargs) # noqa: E501 -
Specification: No tags # noqa: E501
json-formatted version of this spec with the tags removed to help with codegen processes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.spec_no_tags_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def spec_no_tags_with_http_info(self, **kwargs): # noqa: E501 """Specification: No tags # noqa: E501 json-formatted version of this spec with the tags removed to help with codegen processes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.spec_no_tags_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() 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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method spec_no_tags" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/no_tags_spec', 'GET', 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=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_get(self, **kwargs)-
Story: Get List of User Stories # noqa: E501
Returns a list of stories for this user identifie via the access token presentated to 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.story_get(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param bool include_relationships: Indicate whether the returned object should include child relationships :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[Story] If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_get(self, **kwargs): # noqa: E501 """Story: Get List of User Stories # noqa: E501 Returns a list of stories for this user identifie via the access token presentated to 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.story_get(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool include_relationships: Indicate whether the returned object should include child relationships :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[Story] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_get_with_http_info(**kwargs) # noqa: E501 def story_get_with_http_info(self, **kwargs)-
Story: Get List of User Stories # noqa: E501
Returns a list of stories for this user identifie via the access token presentated to 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.story_get_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param bool include_relationships: Indicate whether the returned object should include child relationships :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[Story], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_get_with_http_info(self, **kwargs): # noqa: E501 """Story: Get List of User Stories # noqa: E501 Returns a list of stories for this user identifie via the access token presentated to 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.story_get_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool include_relationships: Indicate whether the returned object should include child relationships :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[Story], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['include_relationships', 'include_outline'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'include_relationships' in local_var_params: query_params.append(('include_relationships', local_var_params['include_relationships'])) # noqa: E501 if 'include_outline' in local_var_params: query_params.append(('include_outline', local_var_params['include_outline'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # 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='list[Story]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_collaborators_get(self, id, **kwargs)-
Story Collaborators: List # noqa: E501
Gets a list users that can read or edit this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_get(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[StoryCollaborator] If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_collaborators_get(self, id, **kwargs): # noqa: E501 """Story Collaborators: List # noqa: E501 Gets a list users that can read or edit this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_get(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[StoryCollaborator] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_collaborators_get_with_http_info(id, **kwargs) # noqa: E501 def story_id_collaborators_get_with_http_info(self, id, **kwargs)-
Story Collaborators: List # noqa: E501
Gets a list users that can read or edit this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_get_with_http_info(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[StoryCollaborator], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_collaborators_get_with_http_info(self, id, **kwargs): # noqa: E501 """Story Collaborators: List # noqa: E501 Gets a list users that can read or edit this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_get_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[StoryCollaborator], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_collaborators_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_collaborators_get`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/collaborators', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[StoryCollaborator]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_collaborators_inactive_post(self, id, modify_inactive_collaborator, **kwargs)-
Story Collaborators: Edit Inactive User Permission # noqa: E501
Edit story permissions for inactive users. Requires admin rights. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_inactive_post(id, modify_inactive_collaborator, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param ModifyInactiveCollaborator modify_inactive_collaborator: Collaborator user id and permission type (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: StoryCollaborator If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_collaborators_inactive_post(self, id, modify_inactive_collaborator, **kwargs): # noqa: E501 """Story Collaborators: Edit Inactive User Permission # noqa: E501 Edit story permissions for inactive users. Requires admin rights. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_inactive_post(id, modify_inactive_collaborator, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param ModifyInactiveCollaborator modify_inactive_collaborator: Collaborator user id and permission type (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: StoryCollaborator If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_collaborators_inactive_post_with_http_info(id, modify_inactive_collaborator, **kwargs) # noqa: E501 def story_id_collaborators_inactive_post_with_http_info(self, id, modify_inactive_collaborator, **kwargs)-
Story Collaborators: Edit Inactive User Permission # noqa: E501
Edit story permissions for inactive users. Requires admin rights. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_inactive_post_with_http_info(id, modify_inactive_collaborator, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param ModifyInactiveCollaborator modify_inactive_collaborator: Collaborator user id and permission type (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(StoryCollaborator, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_collaborators_inactive_post_with_http_info(self, id, modify_inactive_collaborator, **kwargs): # noqa: E501 """Story Collaborators: Edit Inactive User Permission # noqa: E501 Edit story permissions for inactive users. Requires admin rights. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_inactive_post_with_http_info(id, modify_inactive_collaborator, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param ModifyInactiveCollaborator modify_inactive_collaborator: Collaborator user id and permission type (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(StoryCollaborator, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'modify_inactive_collaborator'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_collaborators_inactive_post" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_collaborators_inactive_post`") # noqa: E501 # verify the required parameter 'modify_inactive_collaborator' is set if ('modify_inactive_collaborator' not in local_var_params or local_var_params['modify_inactive_collaborator'] is None): raise ApiValueError("Missing the required parameter `modify_inactive_collaborator` when calling `story_id_collaborators_inactive_post`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'modify_inactive_collaborator' in local_var_params: body_params = local_var_params['modify_inactive_collaborator'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/collaborators/inactive', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='StoryCollaborator', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_collaborators_post(self, id, add_new_collaborator_request, **kwargs)-
Story Collaborators: Add New User # noqa: E501
Add a colloborator to this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_post(id, add_new_collaborator_request, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param AddNewCollaboratorRequest add_new_collaborator_request: Collaborator user id and permission type (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: StoryCollaborator If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_collaborators_post(self, id, add_new_collaborator_request, **kwargs): # noqa: E501 """Story Collaborators: Add New User # noqa: E501 Add a colloborator to this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_post(id, add_new_collaborator_request, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param AddNewCollaboratorRequest add_new_collaborator_request: Collaborator user id and permission type (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: StoryCollaborator If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_collaborators_post_with_http_info(id, add_new_collaborator_request, **kwargs) # noqa: E501 def story_id_collaborators_post_with_http_info(self, id, add_new_collaborator_request, **kwargs)-
Story Collaborators: Add New User # noqa: E501
Add a colloborator to this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_post_with_http_info(id, add_new_collaborator_request, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param AddNewCollaboratorRequest add_new_collaborator_request: Collaborator user id and permission type (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(StoryCollaborator, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_collaborators_post_with_http_info(self, id, add_new_collaborator_request, **kwargs): # noqa: E501 """Story Collaborators: Add New User # noqa: E501 Add a colloborator to this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_post_with_http_info(id, add_new_collaborator_request, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param AddNewCollaboratorRequest add_new_collaborator_request: Collaborator user id and permission type (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(StoryCollaborator, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'add_new_collaborator_request'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_collaborators_post" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_collaborators_post`") # noqa: E501 # verify the required parameter 'add_new_collaborator_request' is set if ('add_new_collaborator_request' not in local_var_params or local_var_params['add_new_collaborator_request'] is None): raise ApiValueError("Missing the required parameter `add_new_collaborator_request` when calling `story_id_collaborators_post`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'add_new_collaborator_request' in local_var_params: body_params = local_var_params['add_new_collaborator_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/collaborators', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='StoryCollaborator', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_collaborators_userid_delete(self, id, story_collaborator_userid, **kwargs)-
Story Collaborators: Remove User # noqa: E501
Remove a collaborator from this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_userid_delete(id, story_collaborator_userid, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_collaborators_userid_delete(self, id, story_collaborator_userid, **kwargs): # noqa: E501 """Story Collaborators: Remove User # noqa: E501 Remove a collaborator from this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_userid_delete(id, story_collaborator_userid, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_collaborators_userid_delete_with_http_info(id, story_collaborator_userid, **kwargs) # noqa: E501 def story_id_collaborators_userid_delete_with_http_info(self, id, story_collaborator_userid, **kwargs)-
Story Collaborators: Remove User # noqa: E501
Remove a collaborator from this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_userid_delete_with_http_info(id, story_collaborator_userid, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_collaborators_userid_delete_with_http_info(self, id, story_collaborator_userid, **kwargs): # noqa: E501 """Story Collaborators: Remove User # noqa: E501 Remove a collaborator from this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_userid_delete_with_http_info(id, story_collaborator_userid, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'story_collaborator_userid'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_collaborators_userid_delete" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_collaborators_userid_delete`") # noqa: E501 # verify the required parameter 'story_collaborator_userid' is set if ('story_collaborator_userid' not in local_var_params or local_var_params['story_collaborator_userid'] is None): raise ApiValueError("Missing the required parameter `story_collaborator_userid` when calling `story_id_collaborators_userid_delete`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 if 'story_collaborator_userid' in local_var_params: path_params['story_collaborator_userid'] = local_var_params['story_collaborator_userid'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/collaborators/{story_collaborator_userid}', 'DELETE', 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=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_collaborators_userid_get(self, id, story_collaborator_userid, **kwargs)-
Story Collaborators: Access Permissions # noqa: E501
Data to help you understand the access rights of a particular collaborator on this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_userid_get(id, story_collaborator_userid, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: StoryCollaborator If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_collaborators_userid_get(self, id, story_collaborator_userid, **kwargs): # noqa: E501 """Story Collaborators: Access Permissions # noqa: E501 Data to help you understand the access rights of a particular collaborator on this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_userid_get(id, story_collaborator_userid, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: StoryCollaborator If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_collaborators_userid_get_with_http_info(id, story_collaborator_userid, **kwargs) # noqa: E501 def story_id_collaborators_userid_get_with_http_info(self, id, story_collaborator_userid, **kwargs)-
Story Collaborators: Access Permissions # noqa: E501
Data to help you understand the access rights of a particular collaborator on this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_userid_get_with_http_info(id, story_collaborator_userid, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(StoryCollaborator, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_collaborators_userid_get_with_http_info(self, id, story_collaborator_userid, **kwargs): # noqa: E501 """Story Collaborators: Access Permissions # noqa: E501 Data to help you understand the access rights of a particular collaborator on this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_userid_get_with_http_info(id, story_collaborator_userid, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(StoryCollaborator, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'story_collaborator_userid'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_collaborators_userid_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_collaborators_userid_get`") # noqa: E501 # verify the required parameter 'story_collaborator_userid' is set if ('story_collaborator_userid' not in local_var_params or local_var_params['story_collaborator_userid'] is None): raise ApiValueError("Missing the required parameter `story_collaborator_userid` when calling `story_id_collaborators_userid_get`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 if 'story_collaborator_userid' in local_var_params: path_params['story_collaborator_userid'] = local_var_params['story_collaborator_userid'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/collaborators/{story_collaborator_userid}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='StoryCollaborator', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_collaborators_userid_permissiontype_get(self, id, story_collaborator_userid, permissiontype, **kwargs)-
Permissions: Story Authorization for a User # noqa: E501
Check whether user have certain types of permissions. Use http status codes to understand if permission is granted - 204 = Granted, 403 = Forbidden # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_userid_permissiontype_get(id, story_collaborator_userid, permissiontype, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param str permissiontype: the type of permission requested. can be a permission_type object name (e.g., owner, editor, create, viewer, admin) or a permission type field (e.g., can_edit, can_view, can_add_collaborators, can_delete) (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_collaborators_userid_permissiontype_get(self, id, story_collaborator_userid, permissiontype, **kwargs): # noqa: E501 """Permissions: Story Authorization for a User # noqa: E501 Check whether user have certain types of permissions. Use http status codes to understand if permission is granted - 204 = Granted, 403 = Forbidden # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_userid_permissiontype_get(id, story_collaborator_userid, permissiontype, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param str permissiontype: the type of permission requested. can be a permission_type object name (e.g., owner, editor, create, viewer, admin) or a permission type field (e.g., can_edit, can_view, can_add_collaborators, can_delete) (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_collaborators_userid_permissiontype_get_with_http_info(id, story_collaborator_userid, permissiontype, **kwargs) # noqa: E501 def story_id_collaborators_userid_permissiontype_get_with_http_info(self, id, story_collaborator_userid, permissiontype, **kwargs)-
Permissions: Story Authorization for a User # noqa: E501
Check whether user have certain types of permissions. Use http status codes to understand if permission is granted - 204 = Granted, 403 = Forbidden # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_userid_permissiontype_get_with_http_info(id, story_collaborator_userid, permissiontype, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param str permissiontype: the type of permission requested. can be a permission_type object name (e.g., owner, editor, create, viewer, admin) or a permission type field (e.g., can_edit, can_view, can_add_collaborators, can_delete) (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_collaborators_userid_permissiontype_get_with_http_info(self, id, story_collaborator_userid, permissiontype, **kwargs): # noqa: E501 """Permissions: Story Authorization for a User # noqa: E501 Check whether user have certain types of permissions. Use http status codes to understand if permission is granted - 204 = Granted, 403 = Forbidden # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_userid_permissiontype_get_with_http_info(id, story_collaborator_userid, permissiontype, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param str permissiontype: the type of permission requested. can be a permission_type object name (e.g., owner, editor, create, viewer, admin) or a permission type field (e.g., can_edit, can_view, can_add_collaborators, can_delete) (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'story_collaborator_userid', 'permissiontype'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_collaborators_userid_permissiontype_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_collaborators_userid_permissiontype_get`") # noqa: E501 # verify the required parameter 'story_collaborator_userid' is set if ('story_collaborator_userid' not in local_var_params or local_var_params['story_collaborator_userid'] is None): raise ApiValueError("Missing the required parameter `story_collaborator_userid` when calling `story_id_collaborators_userid_permissiontype_get`") # noqa: E501 # verify the required parameter 'permissiontype' is set if ('permissiontype' not in local_var_params or local_var_params['permissiontype'] is None): raise ApiValueError("Missing the required parameter `permissiontype` when calling `story_id_collaborators_userid_permissiontype_get`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 if 'story_collaborator_userid' in local_var_params: path_params['story_collaborator_userid'] = local_var_params['story_collaborator_userid'] # noqa: E501 if 'permissiontype' in local_var_params: path_params['permissiontype'] = local_var_params['permissiontype'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/collaborators/authorize/{story_collaborator_userid}/{permissiontype}', 'GET', 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=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_collaborators_userid_put(self, id, story_collaborator_userid, story_collaborator, **kwargs)-
Story Collaborators: Edit Access Rights # noqa: E501
Modify a user's access right to this story (e.g., grant edit permissions) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_userid_put(id, story_collaborator_userid, story_collaborator, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param StoryCollaborator story_collaborator: Collaborator user id (presalytics userid) and permission type (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: StoryCollaborator If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_collaborators_userid_put(self, id, story_collaborator_userid, story_collaborator, **kwargs): # noqa: E501 """Story Collaborators: Edit Access Rights # noqa: E501 Modify a user's access right to this story (e.g., grant edit permissions) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_userid_put(id, story_collaborator_userid, story_collaborator, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param StoryCollaborator story_collaborator: Collaborator user id (presalytics userid) and permission type (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: StoryCollaborator If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_collaborators_userid_put_with_http_info(id, story_collaborator_userid, story_collaborator, **kwargs) # noqa: E501 def story_id_collaborators_userid_put_with_http_info(self, id, story_collaborator_userid, story_collaborator, **kwargs)-
Story Collaborators: Edit Access Rights # noqa: E501
Modify a user's access right to this story (e.g., grant edit permissions) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_collaborators_userid_put_with_http_info(id, story_collaborator_userid, story_collaborator, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param StoryCollaborator story_collaborator: Collaborator user id (presalytics userid) and permission type (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(StoryCollaborator, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_collaborators_userid_put_with_http_info(self, id, story_collaborator_userid, story_collaborator, **kwargs): # noqa: E501 """Story Collaborators: Edit Access Rights # noqa: E501 Modify a user's access right to this story (e.g., grant edit permissions) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_collaborators_userid_put_with_http_info(id, story_collaborator_userid, story_collaborator, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str story_collaborator_userid: The presalytics userid (NOT the Id of the story_collaborator object) (required) :param StoryCollaborator story_collaborator: Collaborator user id (presalytics userid) and permission type (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(StoryCollaborator, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'story_collaborator_userid', 'story_collaborator'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_collaborators_userid_put" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_collaborators_userid_put`") # noqa: E501 # verify the required parameter 'story_collaborator_userid' is set if ('story_collaborator_userid' not in local_var_params or local_var_params['story_collaborator_userid'] is None): raise ApiValueError("Missing the required parameter `story_collaborator_userid` when calling `story_id_collaborators_userid_put`") # noqa: E501 # verify the required parameter 'story_collaborator' is set if ('story_collaborator' not in local_var_params or local_var_params['story_collaborator'] is None): raise ApiValueError("Missing the required parameter `story_collaborator` when calling `story_id_collaborators_userid_put`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 if 'story_collaborator_userid' in local_var_params: path_params['story_collaborator_userid'] = local_var_params['story_collaborator_userid'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'story_collaborator' in local_var_params: body_params = local_var_params['story_collaborator'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/collaborators/{story_collaborator_userid}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='StoryCollaborator', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_d3_id_get(self, id, d3_id, **kwargs)-
Story: Get D3 Iframe # noqa: E501
Gets a barebones html document with objects redender by d3 script with a Restrictive Content-Security-Policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_d3_id_get(id, d3_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str d3_id: A d3 figure id from a D3Widget instance in the Presaltyics Python Library (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_d3_id_get(self, id, d3_id, **kwargs): # noqa: E501 """Story: Get D3 Iframe # noqa: E501 Gets a barebones html document with objects redender by d3 script with a Restrictive Content-Security-Policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_d3_id_get(id, d3_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str d3_id: A d3 figure id from a D3Widget instance in the Presaltyics Python Library (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_d3_id_get_with_http_info(id, d3_id, **kwargs) # noqa: E501 def story_id_d3_id_get_with_http_info(self, id, d3_id, **kwargs)-
Story: Get D3 Iframe # noqa: E501
Gets a barebones html document with objects redender by d3 script with a Restrictive Content-Security-Policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_d3_id_get_with_http_info(id, d3_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str d3_id: A d3 figure id from a D3Widget instance in the Presaltyics Python Library (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_d3_id_get_with_http_info(self, id, d3_id, **kwargs): # noqa: E501 """Story: Get D3 Iframe # noqa: E501 Gets a barebones html document with objects redender by d3 script with a Restrictive Content-Security-Policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_d3_id_get_with_http_info(id, d3_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str d3_id: A d3 figure id from a D3Widget instance in the Presaltyics Python Library (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'd3_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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_d3_id_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_d3_id_get`") # noqa: E501 # verify the required parameter 'd3_id' is set if ('d3_id' not in local_var_params or local_var_params['d3_id'] is None): raise ApiValueError("Missing the required parameter `d3_id` when calling `story_id_d3_id_get`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 if 'd3_id' in local_var_params: path_params['d3_id'] = local_var_params['d3_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( ['text/html']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/d3/{d3_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='str', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_delete(self, id, **kwargs)-
Story: Delete by Id # noqa: E501
Remove a story and dependant data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_delete(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_delete(self, id, **kwargs): # noqa: E501 """Story: Delete by Id # noqa: E501 Remove a story and dependant data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_delete(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_delete_with_http_info(id, **kwargs) # noqa: E501 def story_id_delete_with_http_info(self, id, **kwargs)-
Story: Delete by Id # noqa: E501
Remove a story and dependant data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_delete_with_http_info(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_delete_with_http_info(self, id, **kwargs): # noqa: E501 """Story: Delete by Id # noqa: E501 Remove a story and dependant data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_delete_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_delete" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_delete`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}', 'DELETE', 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=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_file_ooxmlautomationid_get(self, id, ooxml_automation_id, **kwargs)-
Story: Download Updated File # noqa: E501
Redtreives updated story as open office xml file (e.g., .pptx, .docx, .xlsx) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_file_ooxmlautomationid_get(id, ooxml_automation_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str ooxml_automation_id: the id of the ooxml_automation object (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: file If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_file_ooxmlautomationid_get(self, id, ooxml_automation_id, **kwargs): # noqa: E501 """Story: Download Updated File # noqa: E501 Redtreives updated story as open office xml file (e.g., .pptx, .docx, .xlsx) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_file_ooxmlautomationid_get(id, ooxml_automation_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str ooxml_automation_id: the id of the ooxml_automation object (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_file_ooxmlautomationid_get_with_http_info(id, ooxml_automation_id, **kwargs) # noqa: E501 def story_id_file_ooxmlautomationid_get_with_http_info(self, id, ooxml_automation_id, **kwargs)-
Story: Download Updated File # noqa: E501
Redtreives updated story as open office xml file (e.g., .pptx, .docx, .xlsx) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_file_ooxmlautomationid_get_with_http_info(id, ooxml_automation_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str ooxml_automation_id: the id of the ooxml_automation object (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(file, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_file_ooxmlautomationid_get_with_http_info(self, id, ooxml_automation_id, **kwargs): # noqa: E501 """Story: Download Updated File # noqa: E501 Redtreives updated story as open office xml file (e.g., .pptx, .docx, .xlsx) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_file_ooxmlautomationid_get_with_http_info(id, ooxml_automation_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str ooxml_automation_id: the id of the ooxml_automation object (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(file, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'ooxml_automation_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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_file_ooxmlautomationid_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_file_ooxmlautomationid_get`") # noqa: E501 # verify the required parameter 'ooxml_automation_id' is set if ('ooxml_automation_id' not in local_var_params or local_var_params['ooxml_automation_id'] is None): raise ApiValueError("Missing the required parameter `ooxml_automation_id` when calling `story_id_file_ooxmlautomationid_get`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 if 'ooxml_automation_id' in local_var_params: path_params['ooxml_automation_id'] = local_var_params['ooxml_automation_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/vnd.openxmlformats-officedocument.presentationml.presentation', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/file/{ooxml_automation_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='file', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_file_post(self, id, **kwargs)-
Story: Upload a File To Existing Story # noqa: E501
Upload a file to an existing story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_file_post(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param bool replace_existing: Indicates whether a put or post method would replace the existing contents :param str obsolete_id: A primary key pointing to an obsolete item in the story. Item type is context-dependent :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param list[file] file: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Story If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_file_post(self, id, **kwargs): # noqa: E501 """Story: Upload a File To Existing Story # noqa: E501 Upload a file to an existing story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_file_post(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param bool replace_existing: Indicates whether a put or post method would replace the existing contents :param str obsolete_id: A primary key pointing to an obsolete item in the story. Item type is context-dependent :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param list[file] file: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Story If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_file_post_with_http_info(id, **kwargs) # noqa: E501 def story_id_file_post_with_http_info(self, id, **kwargs)-
Story: Upload a File To Existing Story # noqa: E501
Upload a file to an existing story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_file_post_with_http_info(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param bool replace_existing: Indicates whether a put or post method would replace the existing contents :param str obsolete_id: A primary key pointing to an obsolete item in the story. Item type is context-dependent :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param list[file] file: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Story, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_file_post_with_http_info(self, id, **kwargs): # noqa: E501 """Story: Upload a File To Existing Story # noqa: E501 Upload a file to an existing story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_file_post_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param bool replace_existing: Indicates whether a put or post method would replace the existing contents :param str obsolete_id: A primary key pointing to an obsolete item in the story. Item type is context-dependent :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param list[file] file: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Story, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'replace_existing', 'obsolete_id', 'include_outline', 'file'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_file_post" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_file_post`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] if 'replace_existing' in local_var_params: query_params.append(('replace_existing', local_var_params['replace_existing'])) # noqa: E501 if 'obsolete_id' in local_var_params: query_params.append(('obsolete_id', local_var_params['obsolete_id'])) # noqa: E501 if 'include_outline' in local_var_params: query_params.append(('include_outline', local_var_params['include_outline'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} if 'file' in local_var_params: local_var_files['file'] = local_var_params['file'] # noqa: E501 collection_formats['file'] = 'csv' # noqa: E501 body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['multipart/form-data']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/file', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Story', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_get(self, id, **kwargs)-
Story: Get by Id # noqa: E501
Returns story metadata, inlcuding json object with story outline # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_get(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param bool include_relationships: Indicate whether the returned object should include child relationships :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param bool full: Pull a story object with associated collaborator user, permission, and session data(faster if cached from prior api call) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Story If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_get(self, id, **kwargs): # noqa: E501 """Story: Get by Id # noqa: E501 Returns story metadata, inlcuding json object with story outline # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_get(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param bool include_relationships: Indicate whether the returned object should include child relationships :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param bool full: Pull a story object with associated collaborator user, permission, and session data(faster if cached from prior api call) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Story If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_get_with_http_info(id, **kwargs) # noqa: E501 def story_id_get_with_http_info(self, id, **kwargs)-
Story: Get by Id # noqa: E501
Returns story metadata, inlcuding json object with story outline # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_get_with_http_info(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param bool include_relationships: Indicate whether the returned object should include child relationships :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param bool full: Pull a story object with associated collaborator user, permission, and session data(faster if cached from prior api call) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Story, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_get_with_http_info(self, id, **kwargs): # noqa: E501 """Story: Get by Id # noqa: E501 Returns story metadata, inlcuding json object with story outline # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_get_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param bool include_relationships: Indicate whether the returned object should include child relationships :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param bool full: Pull a story object with associated collaborator user, permission, and session data(faster if cached from prior api call) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Story, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'include_relationships', 'include_outline', 'full'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_get`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] if 'include_relationships' in local_var_params: query_params.append(('include_relationships', local_var_params['include_relationships'])) # noqa: E501 if 'include_outline' in local_var_params: query_params.append(('include_outline', local_var_params['include_outline'])) # noqa: E501 if 'full' in local_var_params: query_params.append(('full', local_var_params['full'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Story', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_maplotlib_responsive_figure_id_get(self, id, figure_id, **kwargs)-
Story: Get Matplotlib Iframe # noqa: E501
Gets a barebones html document with a matplotlib chart. Useful for rendering inside responsive iframes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_maplotlib_responsive_figure_id_get(id, figure_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str figure_id: A matplotlib figure id from a MatplotlibResponsiveFigure instance in the Presaltyics Python Library (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_maplotlib_responsive_figure_id_get(self, id, figure_id, **kwargs): # noqa: E501 """Story: Get Matplotlib Iframe # noqa: E501 Gets a barebones html document with a matplotlib chart. Useful for rendering inside responsive iframes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_maplotlib_responsive_figure_id_get(id, figure_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str figure_id: A matplotlib figure id from a MatplotlibResponsiveFigure instance in the Presaltyics Python Library (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_maplotlib_responsive_figure_id_get_with_http_info(id, figure_id, **kwargs) # noqa: E501 def story_id_maplotlib_responsive_figure_id_get_with_http_info(self, id, figure_id, **kwargs)-
Story: Get Matplotlib Iframe # noqa: E501
Gets a barebones html document with a matplotlib chart. Useful for rendering inside responsive iframes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_maplotlib_responsive_figure_id_get_with_http_info(id, figure_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str figure_id: A matplotlib figure id from a MatplotlibResponsiveFigure instance in the Presaltyics Python Library (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_maplotlib_responsive_figure_id_get_with_http_info(self, id, figure_id, **kwargs): # noqa: E501 """Story: Get Matplotlib Iframe # noqa: E501 Gets a barebones html document with a matplotlib chart. Useful for rendering inside responsive iframes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_maplotlib_responsive_figure_id_get_with_http_info(id, figure_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str figure_id: A matplotlib figure id from a MatplotlibResponsiveFigure instance in the Presaltyics Python Library (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'figure_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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_maplotlib_responsive_figure_id_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_maplotlib_responsive_figure_id_get`") # noqa: E501 # verify the required parameter 'figure_id' is set if ('figure_id' not in local_var_params or local_var_params['figure_id'] is None): raise ApiValueError("Missing the required parameter `figure_id` when calling `story_id_maplotlib_responsive_figure_id_get`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 if 'figure_id' in local_var_params: path_params['figure_id'] = local_var_params['figure_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( ['text/html']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/matplotlib-responsive/{figure_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='str', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_outline_get(self, id, **kwargs)-
Story: Get Story Outline # noqa: E501
Returns Story's outline # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_outline_get(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_outline_get(self, id, **kwargs): # noqa: E501 """Story: Get Story Outline # noqa: E501 Returns Story's outline # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_outline_get(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_outline_get_with_http_info(id, **kwargs) # noqa: E501 def story_id_outline_get_with_http_info(self, id, **kwargs)-
Story: Get Story Outline # noqa: E501
Returns Story's outline # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_outline_get_with_http_info(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_outline_get_with_http_info(self, id, **kwargs): # noqa: E501 """Story: Get Story Outline # noqa: E501 Returns Story's outline # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_outline_get_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_outline_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_outline_get`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/outline', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='str', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_outline_post(self, id, body, **kwargs)-
Story: Post Story Outline # noqa: E501
Update a story outline. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_outline_post(id, body, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str body: A story outline object (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_outline_post(self, id, body, **kwargs): # noqa: E501 """Story: Post Story Outline # noqa: E501 Update a story outline. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_outline_post(id, body, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str body: A story outline object (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_outline_post_with_http_info(id, body, **kwargs) # noqa: E501 def story_id_outline_post_with_http_info(self, id, body, **kwargs)-
Story: Post Story Outline # noqa: E501
Update a story outline. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_outline_post_with_http_info(id, body, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str body: A story outline object (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_outline_post_with_http_info(self, id, body, **kwargs): # noqa: E501 """Story: Post Story Outline # noqa: E501 Update a story outline. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_outline_post_with_http_info(id, body, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param str body: A story outline object (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_outline_post" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_outline_post`") # noqa: E501 # verify the required parameter 'body' is set if ('body' not in local_var_params or local_var_params['body'] is None): raise ApiValueError("Missing the required parameter `body` when calling `story_id_outline_post`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'body' in local_var_params: body_params = local_var_params['body'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/outline', '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=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_put(self, id, story, **kwargs)-
Story: Modify # noqa: E501
Update story metadata, including story outline # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_put(id, story, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param Story story: The updated story object (required) :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Story If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_put(self, id, story, **kwargs): # noqa: E501 """Story: Modify # noqa: E501 Update story metadata, including story outline # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_put(id, story, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param Story story: The updated story object (required) :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Story If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_put_with_http_info(id, story, **kwargs) # noqa: E501 def story_id_put_with_http_info(self, id, story, **kwargs)-
Story: Modify # noqa: E501
Update story metadata, including story outline # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_put_with_http_info(id, story, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param Story story: The updated story object (required) :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Story, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_put_with_http_info(self, id, story, **kwargs): # noqa: E501 """Story: Modify # noqa: E501 Update story metadata, including story outline # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_put_with_http_info(id, story, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param Story story: The updated story object (required) :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Story, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'story', 'include_outline'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_put" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_put`") # noqa: E501 # verify the required parameter 'story' is set if ('story' not in local_var_params or local_var_params['story'] is None): raise ApiValueError("Missing the required parameter `story` when calling `story_id_put`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] if 'include_outline' in local_var_params: query_params.append(('include_outline', local_var_params['include_outline'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None if 'story' in local_var_params: body_params = local_var_params['story'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Story', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_reveal(self, id, **kwargs)-
Story: Get Story at Reveal.js Document # noqa: E501
returns an html document containing a reveal.js epresentation of the story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_reveal(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_reveal(self, id, **kwargs): # noqa: E501 """Story: Get Story at Reveal.js Document # noqa: E501 returns an html document containing a reveal.js epresentation of the story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_reveal(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: str If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_reveal_with_http_info(id, **kwargs) # noqa: E501 def story_id_reveal_with_http_info(self, id, **kwargs)-
Story: Get Story at Reveal.js Document # noqa: E501
returns an html document containing a reveal.js epresentation of the story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_reveal_with_http_info(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_reveal_with_http_info(self, id, **kwargs): # noqa: E501 """Story: Get Story at Reveal.js Document # noqa: E501 returns an html document containing a reveal.js epresentation of the story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_reveal_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_reveal" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_reveal`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['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', 'text/html']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/reveal', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='str', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_session_post(self, id, create_session_request, **kwargs)-
Sessions: Create a Session # noqa: E501
Create a new session # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_session_post(id, create_session_request, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param CreateSessionRequest create_session_request: Collaborator user id and permission type (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Session If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_session_post(self, id, create_session_request, **kwargs): # noqa: E501 """Sessions: Create a Session # noqa: E501 Create a new session # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_session_post(id, create_session_request, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param CreateSessionRequest create_session_request: Collaborator user id and permission type (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Session If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_session_post_with_http_info(id, create_session_request, **kwargs) # noqa: E501 def story_id_session_post_with_http_info(self, id, create_session_request, **kwargs)-
Sessions: Create a Session # noqa: E501
Create a new session # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_session_post_with_http_info(id, create_session_request, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param CreateSessionRequest create_session_request: Collaborator user id and permission type (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Session, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_session_post_with_http_info(self, id, create_session_request, **kwargs): # noqa: E501 """Sessions: Create a Session # noqa: E501 Create a new session # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_session_post_with_http_info(id, create_session_request, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param CreateSessionRequest create_session_request: Collaborator user id and permission type (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Session, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'create_session_request'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_session_post" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_session_post`") # noqa: E501 # verify the required parameter 'create_session_request' is set if ('create_session_request' not in local_var_params or local_var_params['create_session_request'] is None): raise ApiValueError("Missing the required parameter `create_session_request` when calling `story_id_session_post`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_session_request' in local_var_params: body_params = local_var_params['create_session_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/sessions', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Session', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_sessions_get(self, id, **kwargs)-
Sessions: List Story Sessions # noqa: E501
Get a list of sessions asscoaited with this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_sessions_get(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param bool include_relationships: Indicate whether the returned object should include child relationships :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[Session] If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_sessions_get(self, id, **kwargs): # noqa: E501 """Sessions: List Story Sessions # noqa: E501 Get a list of sessions asscoaited with this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_sessions_get(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param bool include_relationships: Indicate whether the returned object should include child relationships :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[Session] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_sessions_get_with_http_info(id, **kwargs) # noqa: E501 def story_id_sessions_get_with_http_info(self, id, **kwargs)-
Sessions: List Story Sessions # noqa: E501
Get a list of sessions asscoaited with this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_sessions_get_with_http_info(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param bool include_relationships: Indicate whether the returned object should include child relationships :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[Session], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_sessions_get_with_http_info(self, id, **kwargs): # noqa: E501 """Sessions: List Story Sessions # noqa: E501 Get a list of sessions asscoaited with this story # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_sessions_get_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param bool include_relationships: Indicate whether the returned object should include child relationships :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[Session], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['id', 'include_relationships'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_sessions_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_sessions_get`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] if 'include_relationships' in local_var_params: query_params.append(('include_relationships', local_var_params['include_relationships'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/sessions', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[Session]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_id_status_get(self, id, **kwargs)-
Story: Get Story Status # noqa: E501
Returns code indicating whether story has active running background and is healthy (e.g., the latest outline is valid) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_status_get(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Status If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_status_get(self, id, **kwargs): # noqa: E501 """Story: Get Story Status # noqa: E501 Returns code indicating whether story has active running background and is healthy (e.g., the latest outline is valid) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_status_get(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Status If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_id_status_get_with_http_info(id, **kwargs) # noqa: E501 def story_id_status_get_with_http_info(self, id, **kwargs)-
Story: Get Story Status # noqa: E501
Returns code indicating whether story has active running background and is healthy (e.g., the latest outline is valid) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_id_status_get_with_http_info(id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Status, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_id_status_get_with_http_info(self, id, **kwargs): # noqa: E501 """Story: Get Story Status # noqa: E501 Returns code indicating whether story has active running background and is healthy (e.g., the latest outline is valid) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_id_status_get_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str id: the id from the story object (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Status, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_id_status_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'id' is set if ('id' not in local_var_params or local_var_params['id'] is None): raise ApiValueError("Missing the required parameter `id` when calling `story_id_status_get`") # noqa: E501 collection_formats = {} path_params = {} if 'id' in local_var_params: path_params['id'] = local_var_params['id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/{id}/status', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Status', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_outline_schema(self, schema_version, **kwargs)-
Story Outline Schema # noqa: E501
Json Schema for validating Story Outline objects # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_outline_schema(schema_version, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str schema_version: The semanitic version of a schema (e.g. '0.3.1') (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_outline_schema(self, schema_version, **kwargs): # noqa: E501 """Story Outline Schema # noqa: E501 Json Schema for validating Story Outline objects # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_outline_schema(schema_version, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str schema_version: The semanitic version of a schema (e.g. '0.3.1') (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_outline_schema_with_http_info(schema_version, **kwargs) # noqa: E501 def story_outline_schema_with_http_info(self, schema_version, **kwargs)-
Story Outline Schema # noqa: E501
Json Schema for validating Story Outline objects # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_outline_schema_with_http_info(schema_version, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str schema_version: The semanitic version of a schema (e.g. '0.3.1') (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_outline_schema_with_http_info(self, schema_version, **kwargs): # noqa: E501 """Story Outline Schema # noqa: E501 Json Schema for validating Story Outline objects # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_outline_schema_with_http_info(schema_version, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str schema_version: The semanitic version of a schema (e.g. '0.3.1') (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['schema_version'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_outline_schema" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'schema_version' is set if ('schema_version' not in local_var_params or local_var_params['schema_version'] is None): raise ApiValueError("Missing the required parameter `schema_version` when calling `story_outline_schema`") # noqa: E501 collection_formats = {} path_params = {} if 'schema_version' in local_var_params: path_params['schema_version'] = local_var_params['schema_version'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/outline-schema/{schema_version}/story-outline.json', 'GET', 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=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_permission_types_get(self, **kwargs)-
Permissions: List Permission Types # noqa: E501
Returns a list of possible user permission types # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_permission_types_get(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[PermissionType] If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_permission_types_get(self, **kwargs): # noqa: E501 """Permissions: List Permission Types # noqa: E501 Returns a list of possible user permission types # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_permission_types_get(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: list[PermissionType] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_permission_types_get_with_http_info(**kwargs) # noqa: E501 def story_permission_types_get_with_http_info(self, **kwargs)-
Permissions: List Permission Types # noqa: E501
Returns a list of possible user permission types # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_permission_types_get_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[PermissionType], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_permission_types_get_with_http_info(self, **kwargs): # noqa: E501 """Permissions: List Permission Types # noqa: E501 Returns a list of possible user permission types # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_permission_types_get_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(list[PermissionType], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() 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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_permission_types_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/permission_types', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[PermissionType]', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_post(self, outline, **kwargs)-
Story: Upload # noqa: E501
Upload new story to presalytics 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.story_post(outline, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param Outline outline: A story outline json object (required) :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Story If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_post(self, outline, **kwargs): # noqa: E501 """Story: Upload # noqa: E501 Upload new story to presalytics 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.story_post(outline, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param Outline outline: A story outline json object (required) :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Story If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_post_with_http_info(outline, **kwargs) # noqa: E501 def story_post_with_http_info(self, outline, **kwargs)-
Story: Upload # noqa: E501
Upload new story to presalytics 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.story_post_with_http_info(outline, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param Outline outline: A story outline json object (required) :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Story, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_post_with_http_info(self, outline, **kwargs): # noqa: E501 """Story: Upload # noqa: E501 Upload new story to presalytics 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.story_post_with_http_info(outline, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param Outline outline: A story outline json object (required) :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Story, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['outline', 'include_outline'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_post" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'outline' is set if ('outline' not in local_var_params or local_var_params['outline'] is None): raise ApiValueError("Missing the required parameter `outline` when calling `story_post`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'include_outline' in local_var_params: query_params.append(('include_outline', local_var_params['include_outline'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None if 'outline' in local_var_params: body_params = local_var_params['outline'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Story', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_post_file(self, **kwargs)-
Story: Upload a File # noqa: E501
Upload new story to presalytics api via an Open Office Xml file # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_post_file(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param list[file] file: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Story If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_post_file(self, **kwargs): # noqa: E501 """Story: Upload a File # noqa: E501 Upload new story to presalytics api via an Open Office Xml file # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_post_file(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param list[file] file: :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Story If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_post_file_with_http_info(**kwargs) # noqa: E501 def story_post_file_with_http_info(self, **kwargs)-
Story: Upload a File # noqa: E501
Upload new story to presalytics api via an Open Office Xml file # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_post_file_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param list[file] file: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Story, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_post_file_with_http_info(self, **kwargs): # noqa: E501 """Story: Upload a File # noqa: E501 Upload new story to presalytics api via an Open Office Xml file # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_post_file_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param list[file] file: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Story, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['include_outline', 'file'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_post_file" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'include_outline' in local_var_params: query_params.append(('include_outline', local_var_params['include_outline'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} if 'file' in local_var_params: local_var_files['file'] = local_var_params['file'] # noqa: E501 collection_formats['file'] = 'csv' # noqa: E501 body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['multipart/form-data']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/file', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Story', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def story_post_file_json(self, **kwargs)-
Story: Upload a File (base64) # noqa: E501
Upload new story to presalytics api via an Open Office Xml file # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_post_file_json(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param FileUpload file_upload: A json-formatted object that includes a base64 encoded file (file encoded utf-8) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Story If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_post_file_json(self, **kwargs): # noqa: E501 """Story: Upload a File (base64) # noqa: E501 Upload new story to presalytics api via an Open Office Xml file # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_post_file_json(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param FileUpload file_upload: A json-formatted object that includes a base64 encoded file (file encoded utf-8) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: Story If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.story_post_file_json_with_http_info(**kwargs) # noqa: E501 def story_post_file_json_with_http_info(self, **kwargs)-
Story: Upload a File (base64) # noqa: E501
Upload new story to presalytics api via an Open Office Xml file # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.story_post_file_json_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param FileUpload file_upload: A json-formatted object that includes a base64 encoded file (file encoded utf-8) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Story, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def story_post_file_json_with_http_info(self, **kwargs): # noqa: E501 """Story: Upload a File (base64) # noqa: E501 Upload new story to presalytics api via an Open Office Xml file # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.story_post_file_json_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool include_outline: Determines whether a repsonse including story objects should include the story outline. Defaults to true. Useful for speeding up processing times. :param FileUpload file_upload: A json-formatted object that includes a base64 encoded file (file encoded utf-8) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(Story, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['include_outline', 'file_upload'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method story_post_file_json" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'include_outline' in local_var_params: query_params.append(('include_outline', local_var_params['include_outline'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None if 'file_upload' in local_var_params: body_params = local_var_params['file_upload'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/file/json', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='Story', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def views_id_delete(self, view_id, **kwargs)-
Views: Delete by Id # noqa: E501
Remove a view and dependant data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.views_id_delete(view_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str view_id: The primary key for a page view within a session (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def views_id_delete(self, view_id, **kwargs): # noqa: E501 """Views: Delete by Id # noqa: E501 Remove a view and dependant data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.views_id_delete(view_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str view_id: The primary key for a page view within a session (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.views_id_delete_with_http_info(view_id, **kwargs) # noqa: E501 def views_id_delete_with_http_info(self, view_id, **kwargs)-
Views: Delete by Id # noqa: E501
Remove a view and dependant data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.views_id_delete_with_http_info(view_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str view_id: The primary key for a page view within a session (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def views_id_delete_with_http_info(self, view_id, **kwargs): # noqa: E501 """Views: Delete by Id # noqa: E501 Remove a view and dependant data. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.views_id_delete_with_http_info(view_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str view_id: The primary key for a page view within a session (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['view_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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method views_id_delete" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'view_id' is set if ('view_id' not in local_var_params or local_var_params['view_id'] is None): raise ApiValueError("Missing the required parameter `view_id` when calling `views_id_delete`") # noqa: E501 collection_formats = {} path_params = {} if 'view_id' in local_var_params: path_params['view_id'] = local_var_params['view_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/views/{view_id}', 'DELETE', 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=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) def views_id_get(self, view_id, **kwargs)-
Views: Get View # noqa: E501
Get view meta data # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.views_id_get(view_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str view_id: The primary key for a page view within a session (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: View If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def views_id_get(self, view_id, **kwargs): # noqa: E501 """Views: Get View # noqa: E501 Get view meta data # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.views_id_get(view_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str view_id: The primary key for a page view within a session (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: View If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.views_id_get_with_http_info(view_id, **kwargs) # noqa: E501 def views_id_get_with_http_info(self, view_id, **kwargs)-
Views: Get View # noqa: E501
Get view meta data # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.views_id_get_with_http_info(view_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str view_id: The primary key for a page view within a session (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(View, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
Expand source code Browse git
def views_id_get_with_http_info(self, view_id, **kwargs): # noqa: E501 """Views: Get View # noqa: E501 Get view meta data # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.views_id_get_with_http_info(view_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str view_id: The primary key for a page view within a session (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(View, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['view_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') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method views_id_get" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'view_id' is set if ('view_id' not in local_var_params or local_var_params['view_id'] is None): raise ApiValueError("Missing the required parameter `view_id` when calling `views_id_get`") # noqa: E501 collection_formats = {} path_params = {} if 'view_id' in local_var_params: path_params['view_id'] = local_var_params['view_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( '/views/{view_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='View', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)