Interface IGuestPortalControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IGuestPortalControllerApiAsync : IApiAccessor

Methods

View Source

CreateGuestPortalAsync(CreatePortalOptions, int, CancellationToken)

Create a portal page for your customers or clients to log into email accounts and view emails.

Declaration

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

Remarks

Create a guest login page for customers or clients to access assigned email addresses

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateGuestPortalUserAsync(Guid, CreatePortalUserOptions, int, CancellationToken)

Create a portal guest user

Declaration

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

Remarks

Add customer to portal

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateGuestPortalUserWithHttpInfoAsync(Guid, CreatePortalUserOptions, int, CancellationToken)

Create a portal guest user

Declaration

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)

Remarks

Add customer to portal

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.

Declaration

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)

Remarks

Create a guest login page for customers or clients to access assigned email addresses

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

Declaration

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

Remarks

Get all customers for a portal

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

Declaration

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)

Remarks

Get all customers for a portal

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalAsync(Guid, int, CancellationToken)

Get a client email portal

Declaration

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

Remarks

Fetch a customer guest portal

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUserAsync(Guid, Guid, int, CancellationToken)

Get guest user for portal

Declaration

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

Remarks

Get customer for portal

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUserByIdAsync(Guid, int, CancellationToken)

Get guest user

Declaration

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

Remarks

Get customer by ID

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUserByIdWithHttpInfoAsync(Guid, int, CancellationToken)

Get guest user

Declaration

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)

Remarks

Get customer by ID

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalUserWithHttpInfoAsync(Guid, Guid, int, CancellationToken)

Get guest user for portal

Declaration

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)

Remarks

Get customer for portal

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

Declaration

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

Remarks

Get customers for a portal

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

Declaration

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)

Remarks

Get customers for a portal

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalWithHttpInfoAsync(Guid, int, CancellationToken)

Get a client email portal

Declaration

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)

Remarks

Fetch a customer guest portal

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalsAsync(int, CancellationToken)

Get guest portals

Declaration

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>

Remarks

Get portals

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetGuestPortalsWithHttpInfoAsync(int, CancellationToken)

Get guest portals

Declaration

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>)

Remarks

Get portals

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call