Class ApiAuditLogControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

ApiAuditLogControllerApi

Implements

IApiAuditLogControllerApi

IApiAuditLogControllerApiSync

IApiAuditLogControllerApiAsync

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 ApiAuditLogControllerApi : IApiAuditLogControllerApi, IApiAuditLogControllerApiSync, IApiAuditLogControllerApiAsync, IApiAccessor

Constructors

View Source

ApiAuditLogControllerApi()

Initializes a new instance of the ApiAuditLogControllerApi class.

Declaration

public ApiAuditLogControllerApi()

View Source

ApiAuditLogControllerApi(string)

Initializes a new instance of the ApiAuditLogControllerApi class.

Declaration

public ApiAuditLogControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

View Source

ApiAuditLogControllerApi(Configuration)

Initializes a new instance of the ApiAuditLogControllerApi class using Configuration object

Declaration

public ApiAuditLogControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

View Source

ApiAuditLogControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

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

Declaration

public ApiAuditLogControllerApi(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

GetAuditLogByEventId(string, DateTime?, DateTime?, int)

Declaration

public AuditLogEventDto GetAuditLogByEventId(string eventId, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	eventId
DateTime?	since	(optional)
DateTime?	before	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
AuditLogEventDto	AuditLogEventDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Declaration

public Task<AuditLogEventDto> GetAuditLogByEventIdAsync(string eventId, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	eventId
DateTime?	since	(optional)
DateTime?	before	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<AuditLogEventDto>	Task of AuditLogEventDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAuditLogByEventIdWithHttpInfo(string, DateTime?, DateTime?, int)

Declaration

public ApiResponse<AuditLogEventDto> GetAuditLogByEventIdWithHttpInfo(string eventId, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	eventId
DateTime?	since	(optional)
DateTime?	before	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<AuditLogEventDto>	ApiResponse of AuditLogEventDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Declaration

public Task<ApiResponse<AuditLogEventDto>> GetAuditLogByEventIdWithHttpInfoAsync(string eventId, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	eventId
DateTime?	since	(optional)
DateTime?	before	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Declaration

public AuditLogPageDto GetAuditLogs(DateTime? since = null, DateTime? before = null, string action = null, Guid? userId = null, Guid? actorUserId = null, Guid? targetUserId = null, string resourceType = null, string resourceId = null, string outcome = null, string requestId = null, string ipAddress = null, int? pageSize = null, string cursor = null, int operationIndex = 0)

Parameters

Type	Name	Description
DateTime?	since	(optional)
DateTime?	before	(optional)
string	action	(optional)
Guid?	userId	(optional)
Guid?	actorUserId	(optional)
Guid?	targetUserId	(optional)
string	resourceType	(optional)
string	resourceId	(optional)
string	outcome	(optional)
string	requestId	(optional)
string	ipAddress	(optional)
int?	pageSize	(optional)
string	cursor	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
AuditLogPageDto	AuditLogPageDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Declaration

public Task<AuditLogPageDto> GetAuditLogsAsync(DateTime? since = null, DateTime? before = null, string action = null, Guid? userId = null, Guid? actorUserId = null, Guid? targetUserId = null, string resourceType = null, string resourceId = null, string outcome = null, string requestId = null, string ipAddress = null, int? pageSize = null, string cursor = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
DateTime?	since	(optional)
DateTime?	before	(optional)
string	action	(optional)
Guid?	userId	(optional)
Guid?	actorUserId	(optional)
Guid?	targetUserId	(optional)
string	resourceType	(optional)
string	resourceId	(optional)
string	outcome	(optional)
string	requestId	(optional)
string	ipAddress	(optional)
int?	pageSize	(optional)
string	cursor	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<AuditLogPageDto>	Task of AuditLogPageDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Declaration

public ApiResponse<AuditLogPageDto> GetAuditLogsWithHttpInfo(DateTime? since = null, DateTime? before = null, string action = null, Guid? userId = null, Guid? actorUserId = null, Guid? targetUserId = null, string resourceType = null, string resourceId = null, string outcome = null, string requestId = null, string ipAddress = null, int? pageSize = null, string cursor = null, int operationIndex = 0)

Parameters

Type	Name	Description
DateTime?	since	(optional)
DateTime?	before	(optional)
string	action	(optional)
Guid?	userId	(optional)
Guid?	actorUserId	(optional)
Guid?	targetUserId	(optional)
string	resourceType	(optional)
string	resourceId	(optional)
string	outcome	(optional)
string	requestId	(optional)
string	ipAddress	(optional)
int?	pageSize	(optional)
string	cursor	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<AuditLogPageDto>	ApiResponse of AuditLogPageDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Declaration

public Task<ApiResponse<AuditLogPageDto>> GetAuditLogsWithHttpInfoAsync(DateTime? since = null, DateTime? before = null, string action = null, Guid? userId = null, Guid? actorUserId = null, Guid? targetUserId = null, string resourceType = null, string resourceId = null, string outcome = null, string requestId = null, string ipAddress = null, int? pageSize = null, string cursor = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
DateTime?	since	(optional)
DateTime?	before	(optional)
string	action	(optional)
Guid?	userId	(optional)
Guid?	actorUserId	(optional)
Guid?	targetUserId	(optional)
string	resourceType	(optional)
string	resourceId	(optional)
string	outcome	(optional)
string	requestId	(optional)
string	ipAddress	(optional)
int?	pageSize	(optional)
string	cursor	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

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

SearchAuditLogs(AuditLogSearchOptions, int)

Declaration

public AuditLogPageDto SearchAuditLogs(AuditLogSearchOptions auditLogSearchOptions, int operationIndex = 0)

Parameters

Type	Name	Description
AuditLogSearchOptions	auditLogSearchOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
AuditLogPageDto	AuditLogPageDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SearchAuditLogsAsync(AuditLogSearchOptions, int, CancellationToken)

Declaration

public Task<AuditLogPageDto> SearchAuditLogsAsync(AuditLogSearchOptions auditLogSearchOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<AuditLogPageDto>	Task of AuditLogPageDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SearchAuditLogsWithHttpInfo(AuditLogSearchOptions, int)

Declaration

public ApiResponse<AuditLogPageDto> SearchAuditLogsWithHttpInfo(AuditLogSearchOptions auditLogSearchOptions, int operationIndex = 0)

Parameters

Type	Name	Description
AuditLogSearchOptions	auditLogSearchOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<AuditLogPageDto>	ApiResponse of AuditLogPageDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SearchAuditLogsWithHttpInfoAsync(AuditLogSearchOptions, int, CancellationToken)

Declaration

public Task<ApiResponse<AuditLogPageDto>> SearchAuditLogsWithHttpInfoAsync(AuditLogSearchOptions auditLogSearchOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

IApiAuditLogControllerApi

IApiAuditLogControllerApiSync

IApiAuditLogControllerApiAsync

IApiAccessor