ExportControllerApi
in package
ExportControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['exportEntities' => ['application/json'], 'getExportLink' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- exportEntities() : string
- Operation exportEntities
- exportEntitiesAsync() : PromiseInterface
- Operation exportEntitiesAsync
- exportEntitiesAsyncWithHttpInfo() : PromiseInterface
- Operation exportEntitiesAsyncWithHttpInfo
- exportEntitiesRequest() : Request
- Create request for operation 'exportEntities'
- exportEntitiesWithHttpInfo() : array<string|int, mixed>
- Operation exportEntitiesWithHttpInfo
- getConfig() : Configuration
- getExportLink() : ExportLink
- Operation getExportLink
- getExportLinkAsync() : PromiseInterface
- Operation getExportLinkAsync
- getExportLinkAsyncWithHttpInfo() : PromiseInterface
- Operation getExportLinkAsyncWithHttpInfo
- getExportLinkRequest() : Request
- Create request for operation 'getExportLink'
- getExportLinkWithHttpInfo() : array<string|int, mixed>
- Operation getExportLinkWithHttpInfo
- getHostIndex() : int
- Get the host index
- setHostIndex() : void
- Set the host index
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['exportEntities' => ['application/json'], 'getExportLink' => ['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 —exportEntities()
Operation exportEntities
public
exportEntities(string $export_type, string $api_key, string $output_format[, string $filter = null ][, string $list_separator_token = null ][, bool $exclude_previously_exported = null ][, DateTime $created_earliest_time = null ][, DateTime $created_oldest_time = null ][, string $contentType = self::contentTypes['exportEntities'][0] ]) : string
Export inboxes link callable via browser
Parameters
- $export_type : string
-
export_type (required)
- $api_key : string
-
api_key (required)
- $output_format : string
-
output_format (required)
- $filter : string = null
-
filter (optional)
- $list_separator_token : string = null
-
list_separator_token (optional)
- $exclude_previously_exported : bool = null
-
exclude_previously_exported (optional)
- $created_earliest_time : DateTime = null
-
created_earliest_time (optional)
- $created_oldest_time : DateTime = null
-
created_oldest_time (optional)
- $contentType : string = self::contentTypes['exportEntities'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportEntities'] to see the possible values for this operation
Tags
Return values
string —exportEntitiesAsync()
Operation exportEntitiesAsync
public
exportEntitiesAsync(string $export_type, string $api_key, string $output_format[, string $filter = null ][, string $list_separator_token = null ][, bool $exclude_previously_exported = null ][, DateTime $created_earliest_time = null ][, DateTime $created_oldest_time = null ][, string $contentType = self::contentTypes['exportEntities'][0] ]) : PromiseInterface
Export inboxes link callable via browser
Parameters
- $export_type : string
-
(required)
- $api_key : string
-
(required)
- $output_format : string
-
(required)
- $filter : string = null
-
(optional)
- $list_separator_token : string = null
-
(optional)
- $exclude_previously_exported : bool = null
-
(optional)
- $created_earliest_time : DateTime = null
-
(optional)
- $created_oldest_time : DateTime = null
-
(optional)
- $contentType : string = self::contentTypes['exportEntities'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportEntities'] to see the possible values for this operation
Tags
Return values
PromiseInterface —exportEntitiesAsyncWithHttpInfo()
Operation exportEntitiesAsyncWithHttpInfo
public
exportEntitiesAsyncWithHttpInfo(string $export_type, string $api_key, string $output_format[, string $filter = null ][, string $list_separator_token = null ][, bool $exclude_previously_exported = null ][, DateTime $created_earliest_time = null ][, DateTime $created_oldest_time = null ][, string $contentType = self::contentTypes['exportEntities'][0] ]) : PromiseInterface
Export inboxes link callable via browser
Parameters
- $export_type : string
-
(required)
- $api_key : string
-
(required)
- $output_format : string
-
(required)
- $filter : string = null
-
(optional)
- $list_separator_token : string = null
-
(optional)
- $exclude_previously_exported : bool = null
-
(optional)
- $created_earliest_time : DateTime = null
-
(optional)
- $created_oldest_time : DateTime = null
-
(optional)
- $contentType : string = self::contentTypes['exportEntities'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportEntities'] to see the possible values for this operation
Tags
Return values
PromiseInterface —exportEntitiesRequest()
Create request for operation 'exportEntities'
public
exportEntitiesRequest(string $export_type, string $api_key, string $output_format[, string $filter = null ][, string $list_separator_token = null ][, bool $exclude_previously_exported = null ][, DateTime $created_earliest_time = null ][, DateTime $created_oldest_time = null ][, string $contentType = self::contentTypes['exportEntities'][0] ]) : Request
Parameters
- $export_type : string
-
(required)
- $api_key : string
-
(required)
- $output_format : string
-
(required)
- $filter : string = null
-
(optional)
- $list_separator_token : string = null
-
(optional)
- $exclude_previously_exported : bool = null
-
(optional)
- $created_earliest_time : DateTime = null
-
(optional)
- $created_oldest_time : DateTime = null
-
(optional)
- $contentType : string = self::contentTypes['exportEntities'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportEntities'] to see the possible values for this operation
Tags
Return values
Request —exportEntitiesWithHttpInfo()
Operation exportEntitiesWithHttpInfo
public
exportEntitiesWithHttpInfo(string $export_type, string $api_key, string $output_format[, string $filter = null ][, string $list_separator_token = null ][, bool $exclude_previously_exported = null ][, DateTime $created_earliest_time = null ][, DateTime $created_oldest_time = null ][, string $contentType = self::contentTypes['exportEntities'][0] ]) : array<string|int, mixed>
Export inboxes link callable via browser
Parameters
- $export_type : string
-
(required)
- $api_key : string
-
(required)
- $output_format : string
-
(required)
- $filter : string = null
-
(optional)
- $list_separator_token : string = null
-
(optional)
- $exclude_previously_exported : bool = null
-
(optional)
- $created_earliest_time : DateTime = null
-
(optional)
- $created_oldest_time : DateTime = null
-
(optional)
- $contentType : string = self::contentTypes['exportEntities'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportEntities'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of string, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getExportLink()
Operation getExportLink
public
getExportLink(string $export_type, ExportOptions $export_options[, string $api_key = null ][, string $contentType = self::contentTypes['getExportLink'][0] ]) : ExportLink
Get export link
Parameters
- $export_type : string
-
export_type (required)
- $export_options : ExportOptions
-
export_options (required)
- $api_key : string = null
-
api_key (optional)
- $contentType : string = self::contentTypes['getExportLink'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExportLink'] to see the possible values for this operation
Tags
Return values
ExportLink —getExportLinkAsync()
Operation getExportLinkAsync
public
getExportLinkAsync(string $export_type, ExportOptions $export_options[, string $api_key = null ][, string $contentType = self::contentTypes['getExportLink'][0] ]) : PromiseInterface
Get export link
Parameters
- $export_type : string
-
(required)
- $export_options : ExportOptions
-
(required)
- $api_key : string = null
-
(optional)
- $contentType : string = self::contentTypes['getExportLink'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExportLink'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getExportLinkAsyncWithHttpInfo()
Operation getExportLinkAsyncWithHttpInfo
public
getExportLinkAsyncWithHttpInfo(string $export_type, ExportOptions $export_options[, string $api_key = null ][, string $contentType = self::contentTypes['getExportLink'][0] ]) : PromiseInterface
Get export link
Parameters
- $export_type : string
-
(required)
- $export_options : ExportOptions
-
(required)
- $api_key : string = null
-
(optional)
- $contentType : string = self::contentTypes['getExportLink'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExportLink'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getExportLinkRequest()
Create request for operation 'getExportLink'
public
getExportLinkRequest(string $export_type, ExportOptions $export_options[, string $api_key = null ][, string $contentType = self::contentTypes['getExportLink'][0] ]) : Request
Parameters
- $export_type : string
-
(required)
- $export_options : ExportOptions
-
(required)
- $api_key : string = null
-
(optional)
- $contentType : string = self::contentTypes['getExportLink'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExportLink'] to see the possible values for this operation
Tags
Return values
Request —getExportLinkWithHttpInfo()
Operation getExportLinkWithHttpInfo
public
getExportLinkWithHttpInfo(string $export_type, ExportOptions $export_options[, string $api_key = null ][, string $contentType = self::contentTypes['getExportLink'][0] ]) : array<string|int, mixed>
Get export link
Parameters
- $export_type : string
-
(required)
- $export_options : ExportOptions
-
(required)
- $api_key : string = null
-
(optional)
- $contentType : string = self::contentTypes['getExportLink'][0]
-
The value for the Content-Type header. Check self::contentTypes['getExportLink'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\ExportLink, HTTP status code, HTTP response headers (array of strings)
getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
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