ApiAuditLogControllerApi
in package
ApiAuditLogControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['getAuditLogByEventId' => ['application/json'], 'getAuditLogs' => ['application/json'], 'searchAuditLogs' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- getAuditLogByEventId() : AuditLogEventDto
- Operation getAuditLogByEventId
- getAuditLogByEventIdAsync() : PromiseInterface
- Operation getAuditLogByEventIdAsync
- getAuditLogByEventIdAsyncWithHttpInfo() : PromiseInterface
- Operation getAuditLogByEventIdAsyncWithHttpInfo
- getAuditLogByEventIdRequest() : Request
- Create request for operation 'getAuditLogByEventId'
- getAuditLogByEventIdWithHttpInfo() : array<string|int, mixed>
- Operation getAuditLogByEventIdWithHttpInfo
- getAuditLogs() : AuditLogPageDto
- Operation getAuditLogs
- getAuditLogsAsync() : PromiseInterface
- Operation getAuditLogsAsync
- getAuditLogsAsyncWithHttpInfo() : PromiseInterface
- Operation getAuditLogsAsyncWithHttpInfo
- getAuditLogsRequest() : Request
- Create request for operation 'getAuditLogs'
- getAuditLogsWithHttpInfo() : array<string|int, mixed>
- Operation getAuditLogsWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- searchAuditLogs() : AuditLogPageDto
- Operation searchAuditLogs
- searchAuditLogsAsync() : PromiseInterface
- Operation searchAuditLogsAsync
- searchAuditLogsAsyncWithHttpInfo() : PromiseInterface
- Operation searchAuditLogsAsyncWithHttpInfo
- searchAuditLogsRequest() : Request
- Create request for operation 'searchAuditLogs'
- searchAuditLogsWithHttpInfo() : array<string|int, mixed>
- Operation searchAuditLogsWithHttpInfo
- setHostIndex() : void
- Set the host index
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['getAuditLogByEventId' => ['application/json'], 'getAuditLogs' => ['application/json'], 'searchAuditLogs' => ['application/json']]
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
$hostIndex
protected
int
$hostIndex
Host index
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
- $hostIndex : int
-
(Optional) host index to select the list of hosts if defined in the OpenAPI spec
Return values
mixed —getAuditLogByEventId()
Operation getAuditLogByEventId
public
getAuditLogByEventId(string $event_id[, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAuditLogByEventId'][0] ]) : AuditLogEventDto
Parameters
- $event_id : string
-
event_id (required)
- $since : DateTime = null
-
since (optional)
- $before : DateTime = null
-
before (optional)
- $contentType : string = self::contentTypes['getAuditLogByEventId'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAuditLogByEventId'] to see the possible values for this operation
Tags
Return values
AuditLogEventDto —getAuditLogByEventIdAsync()
Operation getAuditLogByEventIdAsync
public
getAuditLogByEventIdAsync(string $event_id[, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAuditLogByEventId'][0] ]) : PromiseInterface
Parameters
- $event_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $contentType : string = self::contentTypes['getAuditLogByEventId'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAuditLogByEventId'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAuditLogByEventIdAsyncWithHttpInfo()
Operation getAuditLogByEventIdAsyncWithHttpInfo
public
getAuditLogByEventIdAsyncWithHttpInfo(string $event_id[, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAuditLogByEventId'][0] ]) : PromiseInterface
Parameters
- $event_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $contentType : string = self::contentTypes['getAuditLogByEventId'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAuditLogByEventId'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAuditLogByEventIdRequest()
Create request for operation 'getAuditLogByEventId'
public
getAuditLogByEventIdRequest(string $event_id[, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAuditLogByEventId'][0] ]) : Request
Parameters
- $event_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $contentType : string = self::contentTypes['getAuditLogByEventId'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAuditLogByEventId'] to see the possible values for this operation
Tags
Return values
Request —getAuditLogByEventIdWithHttpInfo()
Operation getAuditLogByEventIdWithHttpInfo
public
getAuditLogByEventIdWithHttpInfo(string $event_id[, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAuditLogByEventId'][0] ]) : array<string|int, mixed>
Parameters
- $event_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $contentType : string = self::contentTypes['getAuditLogByEventId'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAuditLogByEventId'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\AuditLogEventDto, HTTP status code, HTTP response headers (array of strings)
getAuditLogs()
Operation getAuditLogs
public
getAuditLogs([DateTime $since = null ][, DateTime $before = null ][, string $action = null ][, string $user_id = null ][, string $actor_user_id = null ][, string $target_user_id = null ][, string $resource_type = null ][, string $resource_id = null ][, string $outcome = null ][, string $request_id = null ][, string $ip_address = null ][, int $page_size = null ][, string $cursor = null ][, string $contentType = self::contentTypes['getAuditLogs'][0] ]) : AuditLogPageDto
Parameters
- $since : DateTime = null
-
since (optional)
- $before : DateTime = null
-
before (optional)
- $action : string = null
-
action (optional)
- $user_id : string = null
-
user_id (optional)
- $actor_user_id : string = null
-
actor_user_id (optional)
- $target_user_id : string = null
-
target_user_id (optional)
- $resource_type : string = null
-
resource_type (optional)
- $resource_id : string = null
-
resource_id (optional)
- $outcome : string = null
-
outcome (optional)
- $request_id : string = null
-
request_id (optional)
- $ip_address : string = null
-
ip_address (optional)
- $page_size : int = null
-
page_size (optional)
- $cursor : string = null
-
cursor (optional)
- $contentType : string = self::contentTypes['getAuditLogs'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAuditLogs'] to see the possible values for this operation
Tags
Return values
AuditLogPageDto —getAuditLogsAsync()
Operation getAuditLogsAsync
public
getAuditLogsAsync([DateTime $since = null ][, DateTime $before = null ][, string $action = null ][, string $user_id = null ][, string $actor_user_id = null ][, string $target_user_id = null ][, string $resource_type = null ][, string $resource_id = null ][, string $outcome = null ][, string $request_id = null ][, string $ip_address = null ][, int $page_size = null ][, string $cursor = null ][, string $contentType = self::contentTypes['getAuditLogs'][0] ]) : PromiseInterface
Parameters
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $action : string = null
-
(optional)
- $user_id : string = null
-
(optional)
- $actor_user_id : string = null
-
(optional)
- $target_user_id : string = null
-
(optional)
- $resource_type : string = null
-
(optional)
- $resource_id : string = null
-
(optional)
- $outcome : string = null
-
(optional)
- $request_id : string = null
-
(optional)
- $ip_address : string = null
-
(optional)
- $page_size : int = null
-
(optional)
- $cursor : string = null
-
(optional)
- $contentType : string = self::contentTypes['getAuditLogs'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAuditLogs'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAuditLogsAsyncWithHttpInfo()
Operation getAuditLogsAsyncWithHttpInfo
public
getAuditLogsAsyncWithHttpInfo([DateTime $since = null ][, DateTime $before = null ][, string $action = null ][, string $user_id = null ][, string $actor_user_id = null ][, string $target_user_id = null ][, string $resource_type = null ][, string $resource_id = null ][, string $outcome = null ][, string $request_id = null ][, string $ip_address = null ][, int $page_size = null ][, string $cursor = null ][, string $contentType = self::contentTypes['getAuditLogs'][0] ]) : PromiseInterface
Parameters
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $action : string = null
-
(optional)
- $user_id : string = null
-
(optional)
- $actor_user_id : string = null
-
(optional)
- $target_user_id : string = null
-
(optional)
- $resource_type : string = null
-
(optional)
- $resource_id : string = null
-
(optional)
- $outcome : string = null
-
(optional)
- $request_id : string = null
-
(optional)
- $ip_address : string = null
-
(optional)
- $page_size : int = null
-
(optional)
- $cursor : string = null
-
(optional)
- $contentType : string = self::contentTypes['getAuditLogs'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAuditLogs'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAuditLogsRequest()
Create request for operation 'getAuditLogs'
public
getAuditLogsRequest([DateTime $since = null ][, DateTime $before = null ][, string $action = null ][, string $user_id = null ][, string $actor_user_id = null ][, string $target_user_id = null ][, string $resource_type = null ][, string $resource_id = null ][, string $outcome = null ][, string $request_id = null ][, string $ip_address = null ][, int $page_size = null ][, string $cursor = null ][, string $contentType = self::contentTypes['getAuditLogs'][0] ]) : Request
Parameters
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $action : string = null
-
(optional)
- $user_id : string = null
-
(optional)
- $actor_user_id : string = null
-
(optional)
- $target_user_id : string = null
-
(optional)
- $resource_type : string = null
-
(optional)
- $resource_id : string = null
-
(optional)
- $outcome : string = null
-
(optional)
- $request_id : string = null
-
(optional)
- $ip_address : string = null
-
(optional)
- $page_size : int = null
-
(optional)
- $cursor : string = null
-
(optional)
- $contentType : string = self::contentTypes['getAuditLogs'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAuditLogs'] to see the possible values for this operation
Tags
Return values
Request —getAuditLogsWithHttpInfo()
Operation getAuditLogsWithHttpInfo
public
getAuditLogsWithHttpInfo([DateTime $since = null ][, DateTime $before = null ][, string $action = null ][, string $user_id = null ][, string $actor_user_id = null ][, string $target_user_id = null ][, string $resource_type = null ][, string $resource_id = null ][, string $outcome = null ][, string $request_id = null ][, string $ip_address = null ][, int $page_size = null ][, string $cursor = null ][, string $contentType = self::contentTypes['getAuditLogs'][0] ]) : array<string|int, mixed>
Parameters
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $action : string = null
-
(optional)
- $user_id : string = null
-
(optional)
- $actor_user_id : string = null
-
(optional)
- $target_user_id : string = null
-
(optional)
- $resource_type : string = null
-
(optional)
- $resource_id : string = null
-
(optional)
- $outcome : string = null
-
(optional)
- $request_id : string = null
-
(optional)
- $ip_address : string = null
-
(optional)
- $page_size : int = null
-
(optional)
- $cursor : string = null
-
(optional)
- $contentType : string = self::contentTypes['getAuditLogs'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAuditLogs'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\AuditLogPageDto, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
searchAuditLogs()
Operation searchAuditLogs
public
searchAuditLogs(AuditLogSearchOptions $audit_log_search_options[, string $contentType = self::contentTypes['searchAuditLogs'][0] ]) : AuditLogPageDto
Parameters
- $audit_log_search_options : AuditLogSearchOptions
-
audit_log_search_options (required)
- $contentType : string = self::contentTypes['searchAuditLogs'][0]
-
The value for the Content-Type header. Check self::contentTypes['searchAuditLogs'] to see the possible values for this operation
Tags
Return values
AuditLogPageDto —searchAuditLogsAsync()
Operation searchAuditLogsAsync
public
searchAuditLogsAsync(AuditLogSearchOptions $audit_log_search_options[, string $contentType = self::contentTypes['searchAuditLogs'][0] ]) : PromiseInterface
Parameters
- $audit_log_search_options : AuditLogSearchOptions
-
(required)
- $contentType : string = self::contentTypes['searchAuditLogs'][0]
-
The value for the Content-Type header. Check self::contentTypes['searchAuditLogs'] to see the possible values for this operation
Tags
Return values
PromiseInterface —searchAuditLogsAsyncWithHttpInfo()
Operation searchAuditLogsAsyncWithHttpInfo
public
searchAuditLogsAsyncWithHttpInfo(AuditLogSearchOptions $audit_log_search_options[, string $contentType = self::contentTypes['searchAuditLogs'][0] ]) : PromiseInterface
Parameters
- $audit_log_search_options : AuditLogSearchOptions
-
(required)
- $contentType : string = self::contentTypes['searchAuditLogs'][0]
-
The value for the Content-Type header. Check self::contentTypes['searchAuditLogs'] to see the possible values for this operation
Tags
Return values
PromiseInterface —searchAuditLogsRequest()
Create request for operation 'searchAuditLogs'
public
searchAuditLogsRequest(AuditLogSearchOptions $audit_log_search_options[, string $contentType = self::contentTypes['searchAuditLogs'][0] ]) : Request
Parameters
- $audit_log_search_options : AuditLogSearchOptions
-
(required)
- $contentType : string = self::contentTypes['searchAuditLogs'][0]
-
The value for the Content-Type header. Check self::contentTypes['searchAuditLogs'] to see the possible values for this operation
Tags
Return values
Request —searchAuditLogsWithHttpInfo()
Operation searchAuditLogsWithHttpInfo
public
searchAuditLogsWithHttpInfo(AuditLogSearchOptions $audit_log_search_options[, string $contentType = self::contentTypes['searchAuditLogs'][0] ]) : array<string|int, mixed>
Parameters
- $audit_log_search_options : AuditLogSearchOptions
-
(required)
- $contentType : string = self::contentTypes['searchAuditLogs'][0]
-
The value for the Content-Type header. Check self::contentTypes['searchAuditLogs'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\AuditLogPageDto, HTTP status code, HTTP response headers (array of strings)
setHostIndex()
Set the host index
public
setHostIndex(int $hostIndex) : void
Parameters
- $hostIndex : int
-
Host index (required)
Return values
void —createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options