Class: SentEmailsControllerApi

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new SentEmailsControllerApi(configuration?)

Parameters

NameType
configurationConfiguration

Inherited from

BaseAPI.constructor

Properties

configuration

Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Methods

getAllSentTrackingPixels

getAllSentTrackingPixels(requestParameters, initOverrides?): Promise<PageTrackingPixelProjection>

Get all sent email tracking pixels in paginated form

Parameters

NameType
requestParametersGetAllSentTrackingPixelsRequest
initOverrides?RequestInit

Returns

Promise<PageTrackingPixelProjection>


getAllSentTrackingPixelsRaw

getAllSentTrackingPixelsRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageTrackingPixelProjection»

Get all sent email tracking pixels in paginated form

Parameters

NameType
requestParametersGetAllSentTrackingPixelsRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<PageTrackingPixelProjection»


getSentEmail

getSentEmail(requestParameters, initOverrides?): Promise<SentEmailDto>

Get sent email receipt

Parameters

NameType
requestParametersGetSentEmailRequest
initOverrides?RequestInit

Returns

Promise<SentEmailDto>


getSentEmailHTMLContent

getSentEmailHTMLContent(requestParameters, initOverrides?): Promise<string>

Get sent email HTML content

Parameters

NameType
requestParametersGetSentEmailHTMLContentRequest
initOverrides?RequestInit

Returns

Promise<string>


getSentEmailHTMLContentRaw

getSentEmailHTMLContentRaw(requestParameters, initOverrides?): Promise<ApiResponse<string»

Get sent email HTML content

Parameters

NameType
requestParametersGetSentEmailHTMLContentRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<string»


getSentEmailRaw

getSentEmailRaw(requestParameters, initOverrides?): Promise<ApiResponse<SentEmailDto»

Get sent email receipt

Parameters

NameType
requestParametersGetSentEmailRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<SentEmailDto»


getSentEmailTrackingPixels

getSentEmailTrackingPixels(requestParameters, initOverrides?): Promise<PageTrackingPixelProjection>

Get all tracking pixels for a sent email in paginated form

Parameters

NameType
requestParametersGetSentEmailTrackingPixelsRequest
initOverrides?RequestInit

Returns

Promise<PageTrackingPixelProjection>


getSentEmailTrackingPixelsRaw

getSentEmailTrackingPixelsRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageTrackingPixelProjection»

Get all tracking pixels for a sent email in paginated form

Parameters

NameType
requestParametersGetSentEmailTrackingPixelsRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<PageTrackingPixelProjection»


getSentEmails

getSentEmails(requestParameters, initOverrides?): Promise<PageSentEmailProjection>

Get all sent emails in paginated form

Parameters

NameType
requestParametersGetSentEmailsRequest
initOverrides?RequestInit

Returns

Promise<PageSentEmailProjection>


getSentEmailsRaw

getSentEmailsRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageSentEmailProjection»

Get all sent emails in paginated form

Parameters

NameType
requestParametersGetSentEmailsRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<PageSentEmailProjection»


getSentOrganizationEmails

getSentOrganizationEmails(requestParameters, initOverrides?): Promise<PageSentEmailProjection>

Get all sent organization emails in paginated form

Parameters

NameType
requestParametersGetSentOrganizationEmailsRequest
initOverrides?RequestInit

Returns

Promise<PageSentEmailProjection>


getSentOrganizationEmailsRaw

getSentOrganizationEmailsRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageSentEmailProjection»

Get all sent organization emails in paginated form

Parameters

NameType
requestParametersGetSentOrganizationEmailsRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<PageSentEmailProjection»


request

Protected request(context, initOverrides?): Promise<Response>

Parameters

NameType
contextRequestOpts
initOverrides?RequestInit

Returns

Promise<Response>

Inherited from

BaseAPI.request


withMiddleware

withMiddleware<T>(…middlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
...middlewaresMiddleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware


withPostMiddleware

withPostMiddleware<T>(…postMiddlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
...postMiddlewares(context: ResponseContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPostMiddleware


withPreMiddleware

withPreMiddleware<T>(…preMiddlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
...preMiddlewares(context: RequestContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPreMiddleware