Class GuestPortalControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

GuestPortalControllerApi

Implements

IGuestPortalControllerApi

IGuestPortalControllerApiSync

IGuestPortalControllerApiAsync

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public class GuestPortalControllerApi : IGuestPortalControllerApi, IGuestPortalControllerApiSync, IGuestPortalControllerApiAsync, IApiAccessor

Constructors

View Source

GuestPortalControllerApi()

Initializes a new instance of the GuestPortalControllerApi class.

Declaration

public GuestPortalControllerApi()

View Source

GuestPortalControllerApi(string)

Initializes a new instance of the GuestPortalControllerApi class.

Declaration

public GuestPortalControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

View Source

GuestPortalControllerApi(Configuration)

Initializes a new instance of the GuestPortalControllerApi class using Configuration object

Declaration

public GuestPortalControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

View Source

GuestPortalControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

Initializes a new instance of the GuestPortalControllerApi class using a Configuration object and client instance.

Declaration

public GuestPortalControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)

Parameters

Type	Name	Description
ISynchronousClient	client	The client interface for synchronous API access.
IAsynchronousClient	asyncClient	The client interface for asynchronous API access.
IReadableConfiguration	configuration	The configuration object.

Properties

View Source

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

View Source

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

View Source

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

View Source

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

View Source

CreateGuestPortal(CreatePortalOptions, int)

Create a portal page for your customers or clients to log into email accounts and view emails. Create a guest login page for customers or clients to access assigned email addresses

Declaration

public GuestPortalDto CreateGuestPortal(CreatePortalOptions createPortalOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreatePortalOptions	createPortalOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
GuestPortalDto	GuestPortalDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateGuestPortalAsync(CreatePortalOptions, int, CancellationToken)

Create a portal page for your customers or clients to log into email accounts and view emails. Create a guest login page for customers or clients to access assigned email addresses

Declaration

public Task<GuestPortalDto> CreateGuestPortalAsync(CreatePortalOptions createPortalOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreatePortalOptions	createPortalOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<GuestPortalDto>	Task of GuestPortalDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateGuestPortalUser(Guid, CreatePortalUserOptions, int)

Create a portal guest user Add customer to portal

Declaration

public GuestPortalUserCreateDto CreateGuestPortalUser(Guid portalId, CreatePortalUserOptions createPortalUserOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	portalId
CreatePortalUserOptions	createPortalUserOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
GuestPortalUserCreateDto	GuestPortalUserCreateDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateGuestPortalUserAsync(Guid, CreatePortalUserOptions, int, CancellationToken)

Create a portal guest user Add customer to portal

Declaration

public Task<GuestPortalUserCreateDto> CreateGuestPortalUserAsync(Guid portalId, CreatePortalUserOptions createPortalUserOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	portalId
CreatePortalUserOptions	createPortalUserOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<GuestPortalUserCreateDto>	Task of GuestPortalUserCreateDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateGuestPortalUserWithHttpInfo(Guid, CreatePortalUserOptions, int)

Create a portal guest user Add customer to portal

Declaration

public ApiResponse<GuestPortalUserCreateDto> CreateGuestPortalUserWithHttpInfo(Guid portalId, CreatePortalUserOptions createPortalUserOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	portalId
CreatePortalUserOptions	createPortalUserOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<GuestPortalUserCreateDto>	ApiResponse of GuestPortalUserCreateDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateGuestPortalUserWithHttpInfoAsync(Guid, CreatePortalUserOptions, int, CancellationToken)

Create a portal guest user Add customer to portal

Declaration

public Task<ApiResponse<GuestPortalUserCreateDto>> CreateGuestPortalUserWithHttpInfoAsync(Guid portalId, CreatePortalUserOptions createPortalUserOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	portalId
CreatePortalUserOptions	createPortalUserOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<GuestPortalUserCreateDto>>	Task of ApiResponse (GuestPortalUserCreateDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateGuestPortalWithHttpInfo(CreatePortalOptions, int)

Create a portal page for your customers or clients to log into email accounts and view emails. Create a guest login page for customers or clients to access assigned email addresses

Declaration

public ApiResponse<GuestPortalDto> CreateGuestPortalWithHttpInfo(CreatePortalOptions createPortalOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreatePortalOptions	createPortalOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<GuestPortalDto>	ApiResponse of GuestPortalDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateGuestPortalWithHttpInfoAsync(CreatePortalOptions, int, CancellationToken)

Create a portal page for your customers or clients to log into email accounts and view emails. Create a guest login page for customers or clients to access assigned email addresses

Declaration

public Task<ApiResponse<GuestPortalDto>> CreateGuestPortalWithHttpInfoAsync(CreatePortalOptions createPortalOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreatePortalOptions	createPortalOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<GuestPortalDto>>	Task of ApiResponse (GuestPortalDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllGuestPortalUsers(Guid?, string, int?, int?, string, DateTime?, DateTime?, int)

Get all guest users for portal Get all customers for a portal

Declaration

public PageGuestPortalUsers GetAllGuestPortalUsers(Guid? portalId = null, string search = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	portalId	Optional portal ID (optional)
string	search	Optional search term (optional)
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageGuestPortalUsers	PageGuestPortalUsers

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllGuestPortalUsersAsync(Guid?, string, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get all guest users for portal Get all customers for a portal

Declaration

public Task<PageGuestPortalUsers> GetAllGuestPortalUsersAsync(Guid? portalId = null, string search = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	portalId	Optional portal ID (optional)
string	search	Optional search term (optional)
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageGuestPortalUsers>	Task of PageGuestPortalUsers

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllGuestPortalUsersWithHttpInfo(Guid?, string, int?, int?, string, DateTime?, DateTime?, int)

Get all guest users for portal Get all customers for a portal

Declaration

public ApiResponse<PageGuestPortalUsers> GetAllGuestPortalUsersWithHttpInfo(Guid? portalId = null, string search = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid?	portalId	Optional portal ID (optional)
string	search	Optional search term (optional)
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageGuestPortalUsers>	ApiResponse of PageGuestPortalUsers

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllGuestPortalUsersWithHttpInfoAsync(Guid?, string, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get all guest users for portal Get all customers for a portal

Declaration

public Task<ApiResponse<PageGuestPortalUsers>> GetAllGuestPortalUsersWithHttpInfoAsync(Guid? portalId = null, string search = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	portalId	Optional portal ID (optional)
string	search	Optional search term (optional)
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageGuestPortalUsers>>	Task of ApiResponse (PageGuestPortalUsers)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

View Source

GetGuestPortal(Guid, int)

Get a client email portal Fetch a customer guest portal

Declaration

public GuestPortalDto GetGuestPortal(Guid portalId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	portalId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
GuestPortalDto	GuestPortalDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalAsync(Guid, int, CancellationToken)

Get a client email portal Fetch a customer guest portal

Declaration

public Task<GuestPortalDto> GetGuestPortalAsync(Guid portalId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	portalId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<GuestPortalDto>	Task of GuestPortalDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUser(Guid, Guid, int)

Get guest user for portal Get customer for portal

Declaration

public GuestPortalUserDto GetGuestPortalUser(Guid portalId, Guid guestId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	portalId
Guid	guestId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
GuestPortalUserDto	GuestPortalUserDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUserAsync(Guid, Guid, int, CancellationToken)

Get guest user for portal Get customer for portal

Declaration

public Task<GuestPortalUserDto> GetGuestPortalUserAsync(Guid portalId, Guid guestId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	portalId
Guid	guestId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<GuestPortalUserDto>	Task of GuestPortalUserDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUserById(Guid, int)

Get guest user Get customer by ID

Declaration

public GuestPortalUserDto GetGuestPortalUserById(Guid guestId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	guestId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
GuestPortalUserDto	GuestPortalUserDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUserByIdAsync(Guid, int, CancellationToken)

Get guest user Get customer by ID

Declaration

public Task<GuestPortalUserDto> GetGuestPortalUserByIdAsync(Guid guestId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	guestId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<GuestPortalUserDto>	Task of GuestPortalUserDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUserByIdWithHttpInfo(Guid, int)

Get guest user Get customer by ID

Declaration

public ApiResponse<GuestPortalUserDto> GetGuestPortalUserByIdWithHttpInfo(Guid guestId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	guestId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<GuestPortalUserDto>	ApiResponse of GuestPortalUserDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUserByIdWithHttpInfoAsync(Guid, int, CancellationToken)

Get guest user Get customer by ID

Declaration

public Task<ApiResponse<GuestPortalUserDto>> GetGuestPortalUserByIdWithHttpInfoAsync(Guid guestId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	guestId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<GuestPortalUserDto>>	Task of ApiResponse (GuestPortalUserDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUserWithHttpInfo(Guid, Guid, int)

Get guest user for portal Get customer for portal

Declaration

public ApiResponse<GuestPortalUserDto> GetGuestPortalUserWithHttpInfo(Guid portalId, Guid guestId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	portalId
Guid	guestId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<GuestPortalUserDto>	ApiResponse of GuestPortalUserDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUserWithHttpInfoAsync(Guid, Guid, int, CancellationToken)

Get guest user for portal Get customer for portal

Declaration

public Task<ApiResponse<GuestPortalUserDto>> GetGuestPortalUserWithHttpInfoAsync(Guid portalId, Guid guestId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	portalId
Guid	guestId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<GuestPortalUserDto>>	Task of ApiResponse (GuestPortalUserDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUsers(Guid, string, int?, int?, string, DateTime?, DateTime?, int)

Get all guest users for portal Get customers for a portal

Declaration

public PageGuestPortalUsers GetGuestPortalUsers(Guid portalId, string search = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	portalId
string	search	Optional search term (optional)
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageGuestPortalUsers	PageGuestPortalUsers

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUsersAsync(Guid, string, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get all guest users for portal Get customers for a portal

Declaration

public Task<PageGuestPortalUsers> GetGuestPortalUsersAsync(Guid portalId, string search = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	portalId
string	search	Optional search term (optional)
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageGuestPortalUsers>	Task of PageGuestPortalUsers

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUsersWithHttpInfo(Guid, string, int?, int?, string, DateTime?, DateTime?, int)

Get all guest users for portal Get customers for a portal

Declaration

public ApiResponse<PageGuestPortalUsers> GetGuestPortalUsersWithHttpInfo(Guid portalId, string search = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	portalId
string	search	Optional search term (optional)
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageGuestPortalUsers>	ApiResponse of PageGuestPortalUsers

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUsersWithHttpInfoAsync(Guid, string, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get all guest users for portal Get customers for a portal

Declaration

public Task<ApiResponse<PageGuestPortalUsers>> GetGuestPortalUsersWithHttpInfoAsync(Guid portalId, string search = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	portalId
string	search	Optional search term (optional)
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size in list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageGuestPortalUsers>>	Task of ApiResponse (PageGuestPortalUsers)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalWithHttpInfo(Guid, int)

Get a client email portal Fetch a customer guest portal

Declaration

public ApiResponse<GuestPortalDto> GetGuestPortalWithHttpInfo(Guid portalId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	portalId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<GuestPortalDto>	ApiResponse of GuestPortalDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalWithHttpInfoAsync(Guid, int, CancellationToken)

Get a client email portal Fetch a customer guest portal

Declaration

public Task<ApiResponse<GuestPortalDto>> GetGuestPortalWithHttpInfoAsync(Guid portalId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	portalId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<GuestPortalDto>>	Task of ApiResponse (GuestPortalDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortals(int)

Get guest portals Get portals

Declaration

public List<GuestPortalDto> GetGuestPortals(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
List<GuestPortalDto>	List<GuestPortalDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalsAsync(int, CancellationToken)

Get guest portals Get portals

Declaration

public Task<List<GuestPortalDto>> GetGuestPortalsAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<List<GuestPortalDto>>	Task of List<GuestPortalDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalsWithHttpInfo(int)

Get guest portals Get portals

Declaration

public ApiResponse<List<GuestPortalDto>> GetGuestPortalsWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<List<GuestPortalDto>>	ApiResponse of List<GuestPortalDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalsWithHttpInfoAsync(int, CancellationToken)

Get guest portals Get portals

Declaration

public Task<ApiResponse<List<GuestPortalDto>>> GetGuestPortalsWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<List<GuestPortalDto>>>	Task of ApiResponse (List<GuestPortalDto>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

IGuestPortalControllerApi

IGuestPortalControllerApiSync

IGuestPortalControllerApiAsync

IApiAccessor