Interface IUserControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IUserControllerApiAsync : IApiAccessor

Methods

View Source

CreateOrUpdateInboxRetentionPolicyForAccountAsync(CreateInboxRetentionPolicyForAccountOptions, int, CancellationToken)

Declaration

Task<InboxRetentionPolicyDto> CreateOrUpdateInboxRetentionPolicyForAccountAsync(CreateInboxRetentionPolicyForAccountOptions createInboxRetentionPolicyForAccountOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<InboxRetentionPolicyDto>	Task of InboxRetentionPolicyDto

Remarks

Create inbox retention policy for your global account

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateOrUpdateInboxRetentionPolicyForAccountWithHttpInfoAsync(CreateInboxRetentionPolicyForAccountOptions, int, CancellationToken)

Declaration

Task<ApiResponse<InboxRetentionPolicyDto>> CreateOrUpdateInboxRetentionPolicyForAccountWithHttpInfoAsync(CreateInboxRetentionPolicyForAccountOptions createInboxRetentionPolicyForAccountOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Create inbox retention policy for your global account

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteInboxRetentionPolicyForAccountAsync(int, CancellationToken)

Declaration

Task<EmptyResponseDto> DeleteInboxRetentionPolicyForAccountAsync(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<EmptyResponseDto>	Task of EmptyResponseDto

Remarks

Delete inbox retention policy for your global account

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteInboxRetentionPolicyForAccountWithHttpInfoAsync(int, CancellationToken)

Declaration

Task<ApiResponse<EmptyResponseDto>> DeleteInboxRetentionPolicyForAccountWithHttpInfoAsync(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<EmptyResponseDto>>	Task of ApiResponse (EmptyResponseDto)

Remarks

Delete inbox retention policy for your global account

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Declaration

Task<PageEntityAutomationItems> GetEntityAutomationsAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = null, Guid? phoneId = null, string filter = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index (optional, default to 0)
int?	size	Optional page size (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to DESC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
Guid?	inboxId	Optional inbox ID (optional)
Guid?	phoneId	Optional phone ID (optional)
string	filter	Optional automation type filter (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageEntityAutomationItems>	Task of PageEntityAutomationItems

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Declaration

Task<ApiResponse<PageEntityAutomationItems>> GetEntityAutomationsWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = null, Guid? phoneId = null, string filter = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index (optional, default to 0)
int?	size	Optional page size (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to DESC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
Guid?	inboxId	Optional inbox ID (optional)
Guid?	phoneId	Optional phone ID (optional)
string	filter	Optional automation type filter (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Declaration

Task<PageEntityEventItems> GetEntityEventsAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = null, Guid? emailId = null, Guid? phoneId = null, Guid? smsId = null, Guid? attachmentId = null, string filter = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index (optional, default to 0)
int?	size	Optional page size (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to DESC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
Guid?	inboxId	Optional inbox ID (optional)
Guid?	emailId	Optional email ID (optional)
Guid?	phoneId	Optional phone ID (optional)
Guid?	smsId	Optional SMS ID (optional)
Guid?	attachmentId	Optional attachment ID (optional)
string	filter	Optional type filter (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageEntityEventItems>	Task of PageEntityEventItems

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Declaration

Task<ApiResponse<PageEntityEventItems>> GetEntityEventsWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = null, Guid? emailId = null, Guid? phoneId = null, Guid? smsId = null, Guid? attachmentId = null, string filter = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index (optional, default to 0)
int?	size	Optional page size (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to DESC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
Guid?	inboxId	Optional inbox ID (optional)
Guid?	emailId	Optional email ID (optional)
Guid?	phoneId	Optional phone ID (optional)
Guid?	smsId	Optional SMS ID (optional)
Guid?	attachmentId	Optional attachment ID (optional)
string	filter	Optional type filter (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetEntityFavoritesAsync(int?, int?, string, DateTime?, DateTime?, string, int, CancellationToken)

Declaration

Task<PageEntityFavouriteItems> GetEntityFavoritesAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string filter = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<PageEntityFavouriteItems>	Task of PageEntityFavouriteItems

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetEntityFavoritesWithHttpInfoAsync(int?, int?, string, DateTime?, DateTime?, string, int, CancellationToken)

Declaration

Task<ApiResponse<PageEntityFavouriteItems>> GetEntityFavoritesWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string filter = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxRetentionPolicyForAccountAsync(int, CancellationToken)

Declaration

Task<InboxRetentionPolicyOptionalDto> GetInboxRetentionPolicyForAccountAsync(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<InboxRetentionPolicyOptionalDto>	Task of InboxRetentionPolicyOptionalDto

Remarks

Get inbox retention policy for your global account

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxRetentionPolicyForAccountWithHttpInfoAsync(int, CancellationToken)

Declaration

Task<ApiResponse<InboxRetentionPolicyOptionalDto>> GetInboxRetentionPolicyForAccountWithHttpInfoAsync(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<InboxRetentionPolicyOptionalDto>>	Task of ApiResponse (InboxRetentionPolicyOptionalDto)

Remarks

Get inbox retention policy for your global account

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetJsonPropertyAsStringAsync(string, object, int, CancellationToken)

Declaration

Task<string> GetJsonPropertyAsStringAsync(string property, object body, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	property	JSON property name or dot separated path selector such as `a.b.c`
object	body
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<string>	Task of string

Remarks

Utility function to extract properties from JSON objects in language where this is cumbersome.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetJsonPropertyAsStringWithHttpInfoAsync(string, object, int, CancellationToken)

Declaration

Task<ApiResponse<string>> GetJsonPropertyAsStringWithHttpInfoAsync(string property, object body, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	property	JSON property name or dot separated path selector such as `a.b.c`
object	body
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Remarks

Utility function to extract properties from JSON objects in language where this is cumbersome.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetUserInfoAsync(int, CancellationToken)

Declaration

Task<UserInfoDto> GetUserInfoAsync(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<UserInfoDto>	Task of UserInfoDto

Remarks

Get account information for your user

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetUserInfoWithHttpInfoAsync(int, CancellationToken)

Declaration

Task<ApiResponse<UserInfoDto>> GetUserInfoWithHttpInfoAsync(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<UserInfoDto>>	Task of ApiResponse (UserInfoDto)

Remarks

Get account information for your user

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call