TrackingControllerApi
in package
TrackingControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['createTrackingPixel' => ['application/json'], 'getAllTrackingPixels' => ['application/json'], 'getTrackingPixel' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- createTrackingPixel() : TrackingPixelDto
- Operation createTrackingPixel
- createTrackingPixelAsync() : PromiseInterface
- Operation createTrackingPixelAsync
- createTrackingPixelAsyncWithHttpInfo() : PromiseInterface
- Operation createTrackingPixelAsyncWithHttpInfo
- createTrackingPixelRequest() : Request
- Create request for operation 'createTrackingPixel'
- createTrackingPixelWithHttpInfo() : array<string|int, mixed>
- Operation createTrackingPixelWithHttpInfo
- getAllTrackingPixels() : PageTrackingPixelProjection
- Operation getAllTrackingPixels
- getAllTrackingPixelsAsync() : PromiseInterface
- Operation getAllTrackingPixelsAsync
- getAllTrackingPixelsAsyncWithHttpInfo() : PromiseInterface
- Operation getAllTrackingPixelsAsyncWithHttpInfo
- getAllTrackingPixelsRequest() : Request
- Create request for operation 'getAllTrackingPixels'
- getAllTrackingPixelsWithHttpInfo() : array<string|int, mixed>
- Operation getAllTrackingPixelsWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- getTrackingPixel() : TrackingPixelDto
- Operation getTrackingPixel
- getTrackingPixelAsync() : PromiseInterface
- Operation getTrackingPixelAsync
- getTrackingPixelAsyncWithHttpInfo() : PromiseInterface
- Operation getTrackingPixelAsyncWithHttpInfo
- getTrackingPixelRequest() : Request
- Create request for operation 'getTrackingPixel'
- getTrackingPixelWithHttpInfo() : array<string|int, mixed>
- Operation getTrackingPixelWithHttpInfo
- setHostIndex() : void
- Set the host index
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['createTrackingPixel' => ['application/json'], 'getAllTrackingPixels' => ['application/json'], 'getTrackingPixel' => ['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 —createTrackingPixel()
Operation createTrackingPixel
public
createTrackingPixel(CreateTrackingPixelOptions $create_tracking_pixel_options[, string $contentType = self::contentTypes['createTrackingPixel'][0] ]) : TrackingPixelDto
Create tracking pixel
Parameters
- $create_tracking_pixel_options : CreateTrackingPixelOptions
-
create_tracking_pixel_options (required)
- $contentType : string = self::contentTypes['createTrackingPixel'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTrackingPixel'] to see the possible values for this operation
Tags
Return values
TrackingPixelDto —createTrackingPixelAsync()
Operation createTrackingPixelAsync
public
createTrackingPixelAsync(CreateTrackingPixelOptions $create_tracking_pixel_options[, string $contentType = self::contentTypes['createTrackingPixel'][0] ]) : PromiseInterface
Create tracking pixel
Parameters
- $create_tracking_pixel_options : CreateTrackingPixelOptions
-
(required)
- $contentType : string = self::contentTypes['createTrackingPixel'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTrackingPixel'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createTrackingPixelAsyncWithHttpInfo()
Operation createTrackingPixelAsyncWithHttpInfo
public
createTrackingPixelAsyncWithHttpInfo(CreateTrackingPixelOptions $create_tracking_pixel_options[, string $contentType = self::contentTypes['createTrackingPixel'][0] ]) : PromiseInterface
Create tracking pixel
Parameters
- $create_tracking_pixel_options : CreateTrackingPixelOptions
-
(required)
- $contentType : string = self::contentTypes['createTrackingPixel'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTrackingPixel'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createTrackingPixelRequest()
Create request for operation 'createTrackingPixel'
public
createTrackingPixelRequest(CreateTrackingPixelOptions $create_tracking_pixel_options[, string $contentType = self::contentTypes['createTrackingPixel'][0] ]) : Request
Parameters
- $create_tracking_pixel_options : CreateTrackingPixelOptions
-
(required)
- $contentType : string = self::contentTypes['createTrackingPixel'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTrackingPixel'] to see the possible values for this operation
Tags
Return values
Request —createTrackingPixelWithHttpInfo()
Operation createTrackingPixelWithHttpInfo
public
createTrackingPixelWithHttpInfo(CreateTrackingPixelOptions $create_tracking_pixel_options[, string $contentType = self::contentTypes['createTrackingPixel'][0] ]) : array<string|int, mixed>
Create tracking pixel
Parameters
- $create_tracking_pixel_options : CreateTrackingPixelOptions
-
(required)
- $contentType : string = self::contentTypes['createTrackingPixel'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTrackingPixel'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\TrackingPixelDto, HTTP status code, HTTP response headers (array of strings)
getAllTrackingPixels()
Operation getAllTrackingPixels
public
getAllTrackingPixels(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllTrackingPixels'][0] ]) : PageTrackingPixelProjection
Get tracking pixels
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getAllTrackingPixels'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllTrackingPixels'] to see the possible values for this operation
Tags
Return values
PageTrackingPixelProjection —getAllTrackingPixelsAsync()
Operation getAllTrackingPixelsAsync
public
getAllTrackingPixelsAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllTrackingPixels'][0] ]) : PromiseInterface
Get tracking pixels
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getAllTrackingPixels'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllTrackingPixels'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllTrackingPixelsAsyncWithHttpInfo()
Operation getAllTrackingPixelsAsyncWithHttpInfo
public
getAllTrackingPixelsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllTrackingPixels'][0] ]) : PromiseInterface
Get tracking pixels
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getAllTrackingPixels'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllTrackingPixels'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllTrackingPixelsRequest()
Create request for operation 'getAllTrackingPixels'
public
getAllTrackingPixelsRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllTrackingPixels'][0] ]) : Request
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getAllTrackingPixels'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllTrackingPixels'] to see the possible values for this operation
Tags
Return values
Request —getAllTrackingPixelsWithHttpInfo()
Operation getAllTrackingPixelsWithHttpInfo
public
getAllTrackingPixelsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllTrackingPixels'][0] ]) : array<string|int, mixed>
Get tracking pixels
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getAllTrackingPixels'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllTrackingPixels'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageTrackingPixelProjection, 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
getTrackingPixel()
Operation getTrackingPixel
public
getTrackingPixel(string $id[, string $contentType = self::contentTypes['getTrackingPixel'][0] ]) : TrackingPixelDto
Get pixel
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['getTrackingPixel'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTrackingPixel'] to see the possible values for this operation
Tags
Return values
TrackingPixelDto —getTrackingPixelAsync()
Operation getTrackingPixelAsync
public
getTrackingPixelAsync(string $id[, string $contentType = self::contentTypes['getTrackingPixel'][0] ]) : PromiseInterface
Get pixel
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getTrackingPixel'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTrackingPixel'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTrackingPixelAsyncWithHttpInfo()
Operation getTrackingPixelAsyncWithHttpInfo
public
getTrackingPixelAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getTrackingPixel'][0] ]) : PromiseInterface
Get pixel
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getTrackingPixel'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTrackingPixel'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTrackingPixelRequest()
Create request for operation 'getTrackingPixel'
public
getTrackingPixelRequest(string $id[, string $contentType = self::contentTypes['getTrackingPixel'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getTrackingPixel'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTrackingPixel'] to see the possible values for this operation
Tags
Return values
Request —getTrackingPixelWithHttpInfo()
Operation getTrackingPixelWithHttpInfo
public
getTrackingPixelWithHttpInfo(string $id[, string $contentType = self::contentTypes['getTrackingPixel'][0] ]) : array<string|int, mixed>
Get pixel
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getTrackingPixel'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTrackingPixel'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\TrackingPixelDto, 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