Class: TrackingControllerApi
Hierarchy
-
↳
TrackingControllerApi
Table of contents
Constructors
Properties
Methods
- createTrackingPixel
- createTrackingPixelRaw
- getAllTrackingPixels
- getAllTrackingPixelsRaw
- getTrackingPixel
- getTrackingPixelRaw
- request
- withMiddleware
- withPostMiddleware
- withPreMiddleware
Constructors
constructor
• new TrackingControllerApi(configuration?
)
Parameters
Name | Type |
---|---|
configuration | Configuration |
Inherited from
Properties
configuration
• Protected
configuration: Configuration
Inherited from
Methods
createTrackingPixel
▸ createTrackingPixel(requestParameters
, initOverrides?
): Promise
<TrackingPixelDto
>
Create a tracking pixel. A tracking pixel is an image that can be embedded in an email. When the email is viewed and the image is seen MailSlurp will mark the pixel as seen. Use tracking pixels to monitor email open events. You can receive open notifications via webhook or by fetching the pixel. Create tracking pixel
Parameters
Name | Type |
---|---|
requestParameters | CreateTrackingPixelRequest |
initOverrides? | RequestInit |
Returns
Promise
<TrackingPixelDto
>
createTrackingPixelRaw
▸ createTrackingPixelRaw(requestParameters
, initOverrides?
): Promise
<ApiResponse
<TrackingPixelDto
>>
Create a tracking pixel. A tracking pixel is an image that can be embedded in an email. When the email is viewed and the image is seen MailSlurp will mark the pixel as seen. Use tracking pixels to monitor email open events. You can receive open notifications via webhook or by fetching the pixel. Create tracking pixel
Parameters
Name | Type |
---|---|
requestParameters | CreateTrackingPixelRequest |
initOverrides? | RequestInit |
Returns
Promise
<ApiResponse
<TrackingPixelDto
>>
getAllTrackingPixels
▸ getAllTrackingPixels(requestParameters
, initOverrides?
): Promise
<PageTrackingPixelProjection
>
List tracking pixels in paginated form Get tracking pixels
Parameters
Name | Type |
---|---|
requestParameters | GetAllTrackingPixelsRequest |
initOverrides? | RequestInit |
Returns
Promise
<PageTrackingPixelProjection
>
getAllTrackingPixelsRaw
▸ getAllTrackingPixelsRaw(requestParameters
, initOverrides?
): Promise
<ApiResponse
<PageTrackingPixelProjection
>>
List tracking pixels in paginated form Get tracking pixels
Parameters
Name | Type |
---|---|
requestParameters | GetAllTrackingPixelsRequest |
initOverrides? | RequestInit |
Returns
Promise
<ApiResponse
<PageTrackingPixelProjection
>>
getTrackingPixel
▸ getTrackingPixel(requestParameters
, initOverrides?
): Promise
<TrackingPixelDto
>
Get pixel
Parameters
Name | Type |
---|---|
requestParameters | GetTrackingPixelRequest |
initOverrides? | RequestInit |
Returns
Promise
<TrackingPixelDto
>
getTrackingPixelRaw
▸ getTrackingPixelRaw(requestParameters
, initOverrides?
): Promise
<ApiResponse
<TrackingPixelDto
>>
Get pixel
Parameters
Name | Type |
---|---|
requestParameters | GetTrackingPixelRequest |
initOverrides? | RequestInit |
Returns
Promise
<ApiResponse
<TrackingPixelDto
>>
request
▸ Protected
request(context
, initOverrides?
): Promise
<Response
>
Parameters
Name | Type |
---|---|
context | RequestOpts |
initOverrides? | RequestInit |
Returns
Promise
<Response
>
Inherited from
withMiddleware
▸ withMiddleware<T
>(this
, ...middlewares
): T
Type parameters
Name | Type |
---|---|
T | extends BaseAPI <T > |
Parameters
Name | Type |
---|---|
this | T |
...middlewares | Middleware [] |
Returns
T
Inherited from
withPostMiddleware
▸ withPostMiddleware<T
>(this
, ...postMiddlewares
): T
Type parameters
Name | Type |
---|---|
T | extends BaseAPI <T > |
Parameters
Name | Type |
---|---|
this | T |
...postMiddlewares | (context : ResponseContext ) => Promise <void |
Returns
T
Inherited from
withPreMiddleware
▸ withPreMiddleware<T
>(this
, ...preMiddlewares
): T
Type parameters
Name | Type |
---|---|
T | extends BaseAPI <T > |
Parameters
Name | Type |
---|---|
this | T |
...preMiddlewares | (context : RequestContext ) => Promise <void |
Returns
T