430 lines
16 KiB
Python
430 lines
16 KiB
Python
# coding: utf-8
|
|
|
|
"""
|
|
eLabFTW REST API v2 Documentation
|
|
|
|
This document describes all available endpoints and methods for eLabFTW's API version 2. # noqa: E501
|
|
|
|
OpenAPI spec version: 2.0.0
|
|
|
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
"""
|
|
|
|
from __future__ import absolute_import
|
|
|
|
import re # noqa: F401
|
|
|
|
# python 2 and python 3 compatibility library
|
|
import six
|
|
|
|
from elabapi_python.api_client import ApiClient
|
|
|
|
|
|
class UsersApi(object):
|
|
"""NOTE: This class is auto generated by the swagger code generator program.
|
|
|
|
Do not edit the class manually.
|
|
Ref: https://github.com/swagger-api/swagger-codegen
|
|
"""
|
|
|
|
def __init__(self, api_client=None):
|
|
if api_client is None:
|
|
api_client = ApiClient()
|
|
self.api_client = api_client
|
|
|
|
def patch_user(self, id, **kwargs): # noqa: E501
|
|
"""Modify a user. # noqa: E501
|
|
|
|
Note: it is possible to use \"me\" instead of the userid to access the user of the API key. # noqa: E501
|
|
This method makes a synchronous HTTP request by default. To make an
|
|
asynchronous HTTP request, please pass async_req=True
|
|
>>> thread = api.patch_user(id, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
:param async_req bool
|
|
:param Id1 id: ID of the user or `me`. (required)
|
|
:param UsersIdBody body: Parameters for modifying a user.
|
|
:return: Users
|
|
If the method is called asynchronously,
|
|
returns the request thread.
|
|
"""
|
|
kwargs['_return_http_data_only'] = True
|
|
if kwargs.get('async_req'):
|
|
return self.patch_user_with_http_info(id, **kwargs) # noqa: E501
|
|
else:
|
|
(data) = self.patch_user_with_http_info(id, **kwargs) # noqa: E501
|
|
return data
|
|
|
|
def patch_user_with_http_info(self, id, **kwargs): # noqa: E501
|
|
"""Modify a user. # noqa: E501
|
|
|
|
Note: it is possible to use \"me\" instead of the userid to access the user of the API key. # noqa: E501
|
|
This method makes a synchronous HTTP request by default. To make an
|
|
asynchronous HTTP request, please pass async_req=True
|
|
>>> thread = api.patch_user_with_http_info(id, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
:param async_req bool
|
|
:param Id1 id: ID of the user or `me`. (required)
|
|
:param UsersIdBody body: Parameters for modifying a user.
|
|
:return: Users
|
|
If the method is called asynchronously,
|
|
returns the request thread.
|
|
"""
|
|
|
|
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')
|
|
|
|
params = locals()
|
|
for key, val in six.iteritems(params['kwargs']):
|
|
if key not in all_params:
|
|
raise TypeError(
|
|
"Got an unexpected keyword argument '%s'"
|
|
" to method patch_user" % key
|
|
)
|
|
params[key] = val
|
|
del params['kwargs']
|
|
# verify the required parameter 'id' is set
|
|
if ('id' not in params or
|
|
params['id'] is None):
|
|
raise ValueError("Missing the required parameter `id` when calling `patch_user`") # noqa: E501
|
|
|
|
collection_formats = {}
|
|
|
|
path_params = {}
|
|
if 'id' in params:
|
|
path_params['id'] = params['id'] # noqa: E501
|
|
|
|
query_params = []
|
|
|
|
header_params = {}
|
|
|
|
form_params = []
|
|
local_var_files = {}
|
|
|
|
body_params = None
|
|
if 'body' in params:
|
|
body_params = params['body']
|
|
# HTTP header `Accept`
|
|
header_params['Accept'] = self.api_client.select_header_accept(
|
|
['application/json']) # 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 = ['token'] # noqa: E501
|
|
|
|
return self.api_client.call_api(
|
|
'/users/{id}', 'PATCH',
|
|
path_params,
|
|
query_params,
|
|
header_params,
|
|
body=body_params,
|
|
post_params=form_params,
|
|
files=local_var_files,
|
|
response_type='Users', # noqa: E501
|
|
auth_settings=auth_settings,
|
|
async_req=params.get('async_req'),
|
|
_return_http_data_only=params.get('_return_http_data_only'),
|
|
_preload_content=params.get('_preload_content', True),
|
|
_request_timeout=params.get('_request_timeout'),
|
|
collection_formats=collection_formats)
|
|
|
|
def post_user(self, **kwargs): # noqa: E501
|
|
"""Create a new user. # noqa: E501
|
|
|
|
An Admin can create a user in its own team only. A sysadmin can specify the team. # noqa: E501
|
|
This method makes a synchronous HTTP request by default. To make an
|
|
asynchronous HTTP request, please pass async_req=True
|
|
>>> thread = api.post_user(async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
:param async_req bool
|
|
:param UsersBody body: Parameters for creating a user.
|
|
:return: None
|
|
If the method is called asynchronously,
|
|
returns the request thread.
|
|
"""
|
|
kwargs['_return_http_data_only'] = True
|
|
if kwargs.get('async_req'):
|
|
return self.post_user_with_http_info(**kwargs) # noqa: E501
|
|
else:
|
|
(data) = self.post_user_with_http_info(**kwargs) # noqa: E501
|
|
return data
|
|
|
|
def post_user_with_http_info(self, **kwargs): # noqa: E501
|
|
"""Create a new user. # noqa: E501
|
|
|
|
An Admin can create a user in its own team only. A sysadmin can specify the team. # noqa: E501
|
|
This method makes a synchronous HTTP request by default. To make an
|
|
asynchronous HTTP request, please pass async_req=True
|
|
>>> thread = api.post_user_with_http_info(async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
:param async_req bool
|
|
:param UsersBody body: Parameters for creating a user.
|
|
:return: None
|
|
If the method is called asynchronously,
|
|
returns the request thread.
|
|
"""
|
|
|
|
all_params = ['body'] # noqa: E501
|
|
all_params.append('async_req')
|
|
all_params.append('_return_http_data_only')
|
|
all_params.append('_preload_content')
|
|
all_params.append('_request_timeout')
|
|
|
|
params = locals()
|
|
for key, val in six.iteritems(params['kwargs']):
|
|
if key not in all_params:
|
|
raise TypeError(
|
|
"Got an unexpected keyword argument '%s'"
|
|
" to method post_user" % key
|
|
)
|
|
params[key] = val
|
|
del params['kwargs']
|
|
|
|
collection_formats = {}
|
|
|
|
path_params = {}
|
|
|
|
query_params = []
|
|
|
|
header_params = {}
|
|
|
|
form_params = []
|
|
local_var_files = {}
|
|
|
|
body_params = None
|
|
if 'body' in params:
|
|
body_params = params['body']
|
|
# HTTP header `Accept`
|
|
header_params['Accept'] = self.api_client.select_header_accept(
|
|
['application/json']) # 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 = ['token'] # noqa: E501
|
|
|
|
return self.api_client.call_api(
|
|
'/users', 'POST',
|
|
path_params,
|
|
query_params,
|
|
header_params,
|
|
body=body_params,
|
|
post_params=form_params,
|
|
files=local_var_files,
|
|
response_type=None, # noqa: E501
|
|
auth_settings=auth_settings,
|
|
async_req=params.get('async_req'),
|
|
_return_http_data_only=params.get('_return_http_data_only'),
|
|
_preload_content=params.get('_preload_content', True),
|
|
_request_timeout=params.get('_request_timeout'),
|
|
collection_formats=collection_formats)
|
|
|
|
def read_user(self, id, **kwargs): # noqa: E501
|
|
"""Read information of a user. # noqa: E501
|
|
|
|
Note: it is possible to use \"me\" instead of the userid to access the user of the API key. # noqa: E501
|
|
This method makes a synchronous HTTP request by default. To make an
|
|
asynchronous HTTP request, please pass async_req=True
|
|
>>> thread = api.read_user(id, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
:param async_req bool
|
|
:param Id1 id: ID of the user or `me`. (required)
|
|
:return: Users
|
|
If the method is called asynchronously,
|
|
returns the request thread.
|
|
"""
|
|
kwargs['_return_http_data_only'] = True
|
|
if kwargs.get('async_req'):
|
|
return self.read_user_with_http_info(id, **kwargs) # noqa: E501
|
|
else:
|
|
(data) = self.read_user_with_http_info(id, **kwargs) # noqa: E501
|
|
return data
|
|
|
|
def read_user_with_http_info(self, id, **kwargs): # noqa: E501
|
|
"""Read information of a user. # noqa: E501
|
|
|
|
Note: it is possible to use \"me\" instead of the userid to access the user of the API key. # noqa: E501
|
|
This method makes a synchronous HTTP request by default. To make an
|
|
asynchronous HTTP request, please pass async_req=True
|
|
>>> thread = api.read_user_with_http_info(id, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
:param async_req bool
|
|
:param Id1 id: ID of the user or `me`. (required)
|
|
:return: Users
|
|
If the method is called asynchronously,
|
|
returns the request thread.
|
|
"""
|
|
|
|
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')
|
|
|
|
params = locals()
|
|
for key, val in six.iteritems(params['kwargs']):
|
|
if key not in all_params:
|
|
raise TypeError(
|
|
"Got an unexpected keyword argument '%s'"
|
|
" to method read_user" % key
|
|
)
|
|
params[key] = val
|
|
del params['kwargs']
|
|
# verify the required parameter 'id' is set
|
|
if ('id' not in params or
|
|
params['id'] is None):
|
|
raise ValueError("Missing the required parameter `id` when calling `read_user`") # noqa: E501
|
|
|
|
collection_formats = {}
|
|
|
|
path_params = {}
|
|
if 'id' in params:
|
|
path_params['id'] = 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 = ['token'] # noqa: E501
|
|
|
|
return self.api_client.call_api(
|
|
'/users/{id}', 'GET',
|
|
path_params,
|
|
query_params,
|
|
header_params,
|
|
body=body_params,
|
|
post_params=form_params,
|
|
files=local_var_files,
|
|
response_type='Users', # noqa: E501
|
|
auth_settings=auth_settings,
|
|
async_req=params.get('async_req'),
|
|
_return_http_data_only=params.get('_return_http_data_only'),
|
|
_preload_content=params.get('_preload_content', True),
|
|
_request_timeout=params.get('_request_timeout'),
|
|
collection_formats=collection_formats)
|
|
|
|
def read_users(self, **kwargs): # noqa: E501
|
|
"""Read users from instance. # noqa: E501
|
|
|
|
Get a list of users with an active account on the instance. # noqa: E501
|
|
This method makes a synchronous HTTP request by default. To make an
|
|
asynchronous HTTP request, please pass async_req=True
|
|
>>> thread = api.read_users(async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
:param async_req bool
|
|
:param int team: Add a filter on the team
|
|
:param int current_team: If set to 1, use the requester's current team as filter.
|
|
:param bool only_admins: Return only team admins.
|
|
:param bool only_archived: Return only archived users.
|
|
:return: list[object]
|
|
If the method is called asynchronously,
|
|
returns the request thread.
|
|
"""
|
|
kwargs['_return_http_data_only'] = True
|
|
if kwargs.get('async_req'):
|
|
return self.read_users_with_http_info(**kwargs) # noqa: E501
|
|
else:
|
|
(data) = self.read_users_with_http_info(**kwargs) # noqa: E501
|
|
return data
|
|
|
|
def read_users_with_http_info(self, **kwargs): # noqa: E501
|
|
"""Read users from instance. # noqa: E501
|
|
|
|
Get a list of users with an active account on the instance. # noqa: E501
|
|
This method makes a synchronous HTTP request by default. To make an
|
|
asynchronous HTTP request, please pass async_req=True
|
|
>>> thread = api.read_users_with_http_info(async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
:param async_req bool
|
|
:param int team: Add a filter on the team
|
|
:param int current_team: If set to 1, use the requester's current team as filter.
|
|
:param bool only_admins: Return only team admins.
|
|
:param bool only_archived: Return only archived users.
|
|
:return: list[object]
|
|
If the method is called asynchronously,
|
|
returns the request thread.
|
|
"""
|
|
|
|
all_params = ['team', 'current_team', 'only_admins', 'only_archived'] # noqa: E501
|
|
all_params.append('async_req')
|
|
all_params.append('_return_http_data_only')
|
|
all_params.append('_preload_content')
|
|
all_params.append('_request_timeout')
|
|
|
|
params = locals()
|
|
for key, val in six.iteritems(params['kwargs']):
|
|
if key not in all_params:
|
|
raise TypeError(
|
|
"Got an unexpected keyword argument '%s'"
|
|
" to method read_users" % key
|
|
)
|
|
params[key] = val
|
|
del params['kwargs']
|
|
|
|
collection_formats = {}
|
|
|
|
path_params = {}
|
|
|
|
query_params = []
|
|
if 'team' in params:
|
|
query_params.append(('team', params['team'])) # noqa: E501
|
|
if 'current_team' in params:
|
|
query_params.append(('currentTeam', params['current_team'])) # noqa: E501
|
|
if 'only_admins' in params:
|
|
query_params.append(('onlyAdmins', params['only_admins'])) # noqa: E501
|
|
if 'only_archived' in params:
|
|
query_params.append(('onlyArchived', params['only_archived'])) # 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 = ['token'] # noqa: E501
|
|
|
|
return self.api_client.call_api(
|
|
'/users', 'GET',
|
|
path_params,
|
|
query_params,
|
|
header_params,
|
|
body=body_params,
|
|
post_params=form_params,
|
|
files=local_var_files,
|
|
response_type='list[object]', # noqa: E501
|
|
auth_settings=auth_settings,
|
|
async_req=params.get('async_req'),
|
|
_return_http_data_only=params.get('_return_http_data_only'),
|
|
_preload_content=params.get('_preload_content', True),
|
|
_request_timeout=params.get('_request_timeout'),
|
|
collection_formats=collection_formats)
|