Module mailslurp_client.api.guest_portal_controller_api
MailSlurp API
MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - Homepage - Get an API KEY - Generated SDK Clients - Examples repository # noqa: E501
The version of the OpenAPI document: 6.5.2 Contact: contact@mailslurp.dev Generated by: https://openapi-generator.tech
Classes
class GuestPortalControllerApi (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
class GuestPortalControllerApi(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 create_guest_portal(self, create_portal_options, **kwargs): # noqa: E501 """Create a portal page for your customers or clients to log into email accounts and view emails. # noqa: E501 Create a guest login page for customers or clients to access assigned email addresses # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_guest_portal(create_portal_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreatePortalOptions create_portal_options: (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: GuestPortalDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_guest_portal_with_http_info(create_portal_options, **kwargs) # noqa: E501 def create_guest_portal_with_http_info(self, create_portal_options, **kwargs): # noqa: E501 """Create a portal page for your customers or clients to log into email accounts and view emails. # noqa: E501 Create a guest login page for customers or clients to access assigned email addresses # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_guest_portal_with_http_info(create_portal_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreatePortalOptions create_portal_options: (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(GuestPortalDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_portal_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_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 create_guest_portal" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_portal_options' is set if self.api_client.client_side_validation and ('create_portal_options' not in local_var_params or # noqa: E501 local_var_params['create_portal_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_portal_options` when calling `create_guest_portal`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_portal_options' in local_var_params: body_params = local_var_params['create_portal_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/guest-portal', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GuestPortalDto', # 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 create_guest_portal_user(self, portal_id, create_portal_user_options, **kwargs): # noqa: E501 """Create a portal guest user # noqa: E501 Add customer to portal # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_guest_portal_user(portal_id, create_portal_user_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str portal_id: (required) :param CreatePortalUserOptions create_portal_user_options: (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: GuestPortalUserCreateDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_guest_portal_user_with_http_info(portal_id, create_portal_user_options, **kwargs) # noqa: E501 def create_guest_portal_user_with_http_info(self, portal_id, create_portal_user_options, **kwargs): # noqa: E501 """Create a portal guest user # noqa: E501 Add customer to portal # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_guest_portal_user_with_http_info(portal_id, create_portal_user_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str portal_id: (required) :param CreatePortalUserOptions create_portal_user_options: (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(GuestPortalUserCreateDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'portal_id', 'create_portal_user_options' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_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 create_guest_portal_user" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'portal_id' is set if self.api_client.client_side_validation and ('portal_id' not in local_var_params or # noqa: E501 local_var_params['portal_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `portal_id` when calling `create_guest_portal_user`") # noqa: E501 # verify the required parameter 'create_portal_user_options' is set if self.api_client.client_side_validation and ('create_portal_user_options' not in local_var_params or # noqa: E501 local_var_params['create_portal_user_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_portal_user_options` when calling `create_guest_portal_user`") # noqa: E501 collection_formats = {} path_params = {} if 'portal_id' in local_var_params: path_params['portalId'] = local_var_params['portal_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_portal_user_options' in local_var_params: body_params = local_var_params['create_portal_user_options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/guest-portal/{portalId}/user', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GuestPortalUserCreateDto', # 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_all_guest_portal_users(self, **kwargs): # noqa: E501 """Get all guest users for portal # noqa: E501 Get all customers for a portal # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_all_guest_portal_users(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str portal_id: Optional portal ID :param str search: Optional search term :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageGuestPortalUsers If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_all_guest_portal_users_with_http_info(**kwargs) # noqa: E501 def get_all_guest_portal_users_with_http_info(self, **kwargs): # noqa: E501 """Get all guest users for portal # noqa: E501 Get all customers for a portal # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_all_guest_portal_users_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str portal_id: Optional portal ID :param str search: Optional search term :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageGuestPortalUsers, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'portal_id', 'search', 'page', 'size', 'sort', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_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_all_guest_portal_users" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] if 'portal_id' in local_var_params and local_var_params['portal_id'] is not None: # noqa: E501 query_params.append(('portalId', local_var_params['portal_id'])) # noqa: E501 if 'search' in local_var_params and local_var_params['search'] is not None: # noqa: E501 query_params.append(('search', local_var_params['search'])) # noqa: E501 if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/guest-portal/user', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageGuestPortalUsers', # 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_guest_portal(self, portal_id, **kwargs): # noqa: E501 """Get a client email portal # noqa: E501 Fetch a customer guest portal # 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_guest_portal(portal_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str portal_id: (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: GuestPortalDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_guest_portal_with_http_info(portal_id, **kwargs) # noqa: E501 def get_guest_portal_with_http_info(self, portal_id, **kwargs): # noqa: E501 """Get a client email portal # noqa: E501 Fetch a customer guest portal # 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_guest_portal_with_http_info(portal_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str portal_id: (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(GuestPortalDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'portal_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_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_guest_portal" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'portal_id' is set if self.api_client.client_side_validation and ('portal_id' not in local_var_params or # noqa: E501 local_var_params['portal_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `portal_id` when calling `get_guest_portal`") # noqa: E501 collection_formats = {} path_params = {} if 'portal_id' in local_var_params: path_params['portalId'] = local_var_params['portal_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( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/guest-portal/{portalId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GuestPortalDto', # 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_guest_portal_user(self, portal_id, guest_id, **kwargs): # noqa: E501 """Get guest user for portal # noqa: E501 Get customer for portal # 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_guest_portal_user(portal_id, guest_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str portal_id: (required) :param str guest_id: (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: GuestPortalUserDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_guest_portal_user_with_http_info(portal_id, guest_id, **kwargs) # noqa: E501 def get_guest_portal_user_with_http_info(self, portal_id, guest_id, **kwargs): # noqa: E501 """Get guest user for portal # noqa: E501 Get customer for portal # 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_guest_portal_user_with_http_info(portal_id, guest_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str portal_id: (required) :param str guest_id: (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(GuestPortalUserDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'portal_id', 'guest_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_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_guest_portal_user" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'portal_id' is set if self.api_client.client_side_validation and ('portal_id' not in local_var_params or # noqa: E501 local_var_params['portal_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `portal_id` when calling `get_guest_portal_user`") # noqa: E501 # verify the required parameter 'guest_id' is set if self.api_client.client_side_validation and ('guest_id' not in local_var_params or # noqa: E501 local_var_params['guest_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `guest_id` when calling `get_guest_portal_user`") # noqa: E501 collection_formats = {} path_params = {} if 'portal_id' in local_var_params: path_params['portalId'] = local_var_params['portal_id'] # noqa: E501 if 'guest_id' in local_var_params: path_params['guestId'] = local_var_params['guest_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( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/guest-portal/{portalId}/user/{guestId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GuestPortalUserDto', # 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_guest_portal_user_by_id(self, guest_id, **kwargs): # noqa: E501 """Get guest user # noqa: E501 Get customer by ID # 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_guest_portal_user_by_id(guest_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str guest_id: (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: GuestPortalUserDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_guest_portal_user_by_id_with_http_info(guest_id, **kwargs) # noqa: E501 def get_guest_portal_user_by_id_with_http_info(self, guest_id, **kwargs): # noqa: E501 """Get guest user # noqa: E501 Get customer by ID # 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_guest_portal_user_by_id_with_http_info(guest_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str guest_id: (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(GuestPortalUserDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'guest_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_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_guest_portal_user_by_id" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'guest_id' is set if self.api_client.client_side_validation and ('guest_id' not in local_var_params or # noqa: E501 local_var_params['guest_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `guest_id` when calling `get_guest_portal_user_by_id`") # noqa: E501 collection_formats = {} path_params = {} if 'guest_id' in local_var_params: path_params['guestId'] = local_var_params['guest_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( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/guest-portal/user/{guestId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='GuestPortalUserDto', # 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_guest_portal_users(self, portal_id, **kwargs): # noqa: E501 """Get all guest users for portal # noqa: E501 Get customers for a portal # 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_guest_portal_users(portal_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str portal_id: (required) :param str search: Optional search term :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageGuestPortalUsers If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_guest_portal_users_with_http_info(portal_id, **kwargs) # noqa: E501 def get_guest_portal_users_with_http_info(self, portal_id, **kwargs): # noqa: E501 """Get all guest users for portal # noqa: E501 Get customers for a portal # 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_guest_portal_users_with_http_info(portal_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str portal_id: (required) :param str search: Optional search term :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageGuestPortalUsers, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'portal_id', 'search', 'page', 'size', 'sort', 'since', 'before' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_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_guest_portal_users" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'portal_id' is set if self.api_client.client_side_validation and ('portal_id' not in local_var_params or # noqa: E501 local_var_params['portal_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `portal_id` when calling `get_guest_portal_users`") # noqa: E501 collection_formats = {} path_params = {} if 'portal_id' in local_var_params: path_params['portalId'] = local_var_params['portal_id'] # noqa: E501 query_params = [] if 'search' in local_var_params and local_var_params['search'] is not None: # noqa: E501 query_params.append(('search', local_var_params['search'])) # noqa: E501 if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/guest-portal/{portalId}/user', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageGuestPortalUsers', # 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_guest_portals(self, **kwargs): # noqa: E501 """Get guest portals # noqa: E501 Get portals # 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_guest_portals(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[GuestPortalDto] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_guest_portals_with_http_info(**kwargs) # noqa: E501 def get_guest_portals_with_http_info(self, **kwargs): # noqa: E501 """Get guest portals # noqa: E501 Get portals # 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_guest_portals_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[GuestPortalDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_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_guest_portals" % 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( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/guest-portal', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='list[GuestPortalDto]', # 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 create_guest_portal(self, create_portal_options, **kwargs)-
Create a portal page for your customers or clients to log into email accounts and view emails. # noqa: E501
Create a guest login page for customers or clients to access assigned email addresses # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_guest_portal(create_portal_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreatePortalOptions create_portal_options: (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: GuestPortalDto If the method is called asynchronously, returns the request thread.
def create_guest_portal_user(self, portal_id, create_portal_user_options, **kwargs)-
Create a portal guest user # noqa: E501
Add customer to portal # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_guest_portal_user(portal_id, create_portal_user_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str portal_id: (required) :param CreatePortalUserOptions create_portal_user_options: (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: GuestPortalUserCreateDto If the method is called asynchronously, returns the request thread.
def create_guest_portal_user_with_http_info(self, portal_id, create_portal_user_options, **kwargs)-
Create a portal guest user # noqa: E501
Add customer to portal # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_guest_portal_user_with_http_info(portal_id, create_portal_user_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str portal_id: (required) :param CreatePortalUserOptions create_portal_user_options: (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(GuestPortalUserCreateDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def create_guest_portal_with_http_info(self, create_portal_options, **kwargs)-
Create a portal page for your customers or clients to log into email accounts and view emails. # noqa: E501
Create a guest login page for customers or clients to access assigned email addresses # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_guest_portal_with_http_info(create_portal_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreatePortalOptions create_portal_options: (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(GuestPortalDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_all_guest_portal_users(self, **kwargs)-
Get all guest users for portal # noqa: E501
Get all customers for a portal # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_guest_portal_users(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str portal_id: Optional portal ID :param str search: Optional search term :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageGuestPortalUsers If the method is called asynchronously, returns the request thread.
def get_all_guest_portal_users_with_http_info(self, **kwargs)-
Get all guest users for portal # noqa: E501
Get all customers for a portal # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_all_guest_portal_users_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str portal_id: Optional portal ID :param str search: Optional search term :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageGuestPortalUsers, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_guest_portal(self, portal_id, **kwargs)-
Get a client email portal # noqa: E501
Fetch a customer guest portal # 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_guest_portal(portal_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str portal_id: (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: GuestPortalDto If the method is called asynchronously, returns the request thread.
def get_guest_portal_user(self, portal_id, guest_id, **kwargs)-
Get guest user for portal # noqa: E501
Get customer for portal # 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_guest_portal_user(portal_id, guest_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str portal_id: (required) :param str guest_id: (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: GuestPortalUserDto If the method is called asynchronously, returns the request thread.
def get_guest_portal_user_by_id(self, guest_id, **kwargs)-
Get guest user # noqa: E501
Get customer by ID # 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_guest_portal_user_by_id(guest_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str guest_id: (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: GuestPortalUserDto If the method is called asynchronously, returns the request thread.
def get_guest_portal_user_by_id_with_http_info(self, guest_id, **kwargs)-
Get guest user # noqa: E501
Get customer by ID # 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_guest_portal_user_by_id_with_http_info(guest_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str guest_id: (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(GuestPortalUserDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_guest_portal_user_with_http_info(self, portal_id, guest_id, **kwargs)-
Get guest user for portal # noqa: E501
Get customer for portal # 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_guest_portal_user_with_http_info(portal_id, guest_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str portal_id: (required) :param str guest_id: (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(GuestPortalUserDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_guest_portal_users(self, portal_id, **kwargs)-
Get all guest users for portal # noqa: E501
Get customers for a portal # 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_guest_portal_users(portal_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str portal_id: (required) :param str search: Optional search term :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: PageGuestPortalUsers If the method is called asynchronously, returns the request thread.
def get_guest_portal_users_with_http_info(self, portal_id, **kwargs)-
Get all guest users for portal # noqa: E501
Get customers for a portal # 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_guest_portal_users_with_http_info(portal_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str portal_id: (required) :param str search: Optional search term :param int page: Optional page index in list pagination :param int size: Optional page size in list pagination :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :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(PageGuestPortalUsers, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_guest_portal_with_http_info(self, portal_id, **kwargs)-
Get a client email portal # noqa: E501
Fetch a customer guest portal # 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_guest_portal_with_http_info(portal_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str portal_id: (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(GuestPortalDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_guest_portals(self, **kwargs)-
Get guest portals # noqa: E501
Get portals # 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_guest_portals(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[GuestPortalDto] If the method is called asynchronously, returns the request thread.
def get_guest_portals_with_http_info(self, **kwargs)-
Get guest portals # noqa: E501
Get portals # 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_guest_portals_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[GuestPortalDto], status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.