TemplateControllerApi
in package
TemplateControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['createTemplate' => ['application/json'], 'deleteTemplate' => ['application/json'], 'getAllTemplates' => ['application/json'], 'getTemplate' => ['application/json'], 'getTemplatePreviewHtml' => ['application/json'], 'getTemplatePreviewJson' => ['application/json'], 'getTemplates' => ['application/json'], 'updateTemplate' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- createTemplate() : TemplateDto
- Operation createTemplate
- createTemplateAsync() : PromiseInterface
- Operation createTemplateAsync
- createTemplateAsyncWithHttpInfo() : PromiseInterface
- Operation createTemplateAsyncWithHttpInfo
- createTemplateRequest() : Request
- Create request for operation 'createTemplate'
- createTemplateWithHttpInfo() : array<string|int, mixed>
- Operation createTemplateWithHttpInfo
- deleteTemplate() : void
- Operation deleteTemplate
- deleteTemplateAsync() : PromiseInterface
- Operation deleteTemplateAsync
- deleteTemplateAsyncWithHttpInfo() : PromiseInterface
- Operation deleteTemplateAsyncWithHttpInfo
- deleteTemplateRequest() : Request
- Create request for operation 'deleteTemplate'
- deleteTemplateWithHttpInfo() : array<string|int, mixed>
- Operation deleteTemplateWithHttpInfo
- getAllTemplates() : PageTemplateProjection
- Operation getAllTemplates
- getAllTemplatesAsync() : PromiseInterface
- Operation getAllTemplatesAsync
- getAllTemplatesAsyncWithHttpInfo() : PromiseInterface
- Operation getAllTemplatesAsyncWithHttpInfo
- getAllTemplatesRequest() : Request
- Create request for operation 'getAllTemplates'
- getAllTemplatesWithHttpInfo() : array<string|int, mixed>
- Operation getAllTemplatesWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- getTemplate() : TemplateDto
- Operation getTemplate
- getTemplateAsync() : PromiseInterface
- Operation getTemplateAsync
- getTemplateAsyncWithHttpInfo() : PromiseInterface
- Operation getTemplateAsyncWithHttpInfo
- getTemplatePreviewHtml() : string
- Operation getTemplatePreviewHtml
- getTemplatePreviewHtmlAsync() : PromiseInterface
- Operation getTemplatePreviewHtmlAsync
- getTemplatePreviewHtmlAsyncWithHttpInfo() : PromiseInterface
- Operation getTemplatePreviewHtmlAsyncWithHttpInfo
- getTemplatePreviewHtmlRequest() : Request
- Create request for operation 'getTemplatePreviewHtml'
- getTemplatePreviewHtmlWithHttpInfo() : array<string|int, mixed>
- Operation getTemplatePreviewHtmlWithHttpInfo
- getTemplatePreviewJson() : TemplatePreview
- Operation getTemplatePreviewJson
- getTemplatePreviewJsonAsync() : PromiseInterface
- Operation getTemplatePreviewJsonAsync
- getTemplatePreviewJsonAsyncWithHttpInfo() : PromiseInterface
- Operation getTemplatePreviewJsonAsyncWithHttpInfo
- getTemplatePreviewJsonRequest() : Request
- Create request for operation 'getTemplatePreviewJson'
- getTemplatePreviewJsonWithHttpInfo() : array<string|int, mixed>
- Operation getTemplatePreviewJsonWithHttpInfo
- getTemplateRequest() : Request
- Create request for operation 'getTemplate'
- getTemplates() : array<string|int, TemplateProjection>
- Operation getTemplates
- getTemplatesAsync() : PromiseInterface
- Operation getTemplatesAsync
- getTemplatesAsyncWithHttpInfo() : PromiseInterface
- Operation getTemplatesAsyncWithHttpInfo
- getTemplatesRequest() : Request
- Create request for operation 'getTemplates'
- getTemplatesWithHttpInfo() : array<string|int, mixed>
- Operation getTemplatesWithHttpInfo
- getTemplateWithHttpInfo() : array<string|int, mixed>
- Operation getTemplateWithHttpInfo
- setHostIndex() : void
- Set the host index
- updateTemplate() : TemplateDto
- Operation updateTemplate
- updateTemplateAsync() : PromiseInterface
- Operation updateTemplateAsync
- updateTemplateAsyncWithHttpInfo() : PromiseInterface
- Operation updateTemplateAsyncWithHttpInfo
- updateTemplateRequest() : Request
- Create request for operation 'updateTemplate'
- updateTemplateWithHttpInfo() : array<string|int, mixed>
- Operation updateTemplateWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['createTemplate' => ['application/json'], 'deleteTemplate' => ['application/json'], 'getAllTemplates' => ['application/json'], 'getTemplate' => ['application/json'], 'getTemplatePreviewHtml' => ['application/json'], 'getTemplatePreviewJson' => ['application/json'], 'getTemplates' => ['application/json'], 'updateTemplate' => ['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 —createTemplate()
Operation createTemplate
public
createTemplate(CreateTemplateOptions $create_template_options[, string $contentType = self::contentTypes['createTemplate'][0] ]) : TemplateDto
Create a Template
Parameters
- $create_template_options : CreateTemplateOptions
-
create_template_options (required)
- $contentType : string = self::contentTypes['createTemplate'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTemplate'] to see the possible values for this operation
Tags
Return values
TemplateDto —createTemplateAsync()
Operation createTemplateAsync
public
createTemplateAsync(CreateTemplateOptions $create_template_options[, string $contentType = self::contentTypes['createTemplate'][0] ]) : PromiseInterface
Create a Template
Parameters
- $create_template_options : CreateTemplateOptions
-
(required)
- $contentType : string = self::contentTypes['createTemplate'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTemplate'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createTemplateAsyncWithHttpInfo()
Operation createTemplateAsyncWithHttpInfo
public
createTemplateAsyncWithHttpInfo(CreateTemplateOptions $create_template_options[, string $contentType = self::contentTypes['createTemplate'][0] ]) : PromiseInterface
Create a Template
Parameters
- $create_template_options : CreateTemplateOptions
-
(required)
- $contentType : string = self::contentTypes['createTemplate'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTemplate'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createTemplateRequest()
Create request for operation 'createTemplate'
public
createTemplateRequest(CreateTemplateOptions $create_template_options[, string $contentType = self::contentTypes['createTemplate'][0] ]) : Request
Parameters
- $create_template_options : CreateTemplateOptions
-
(required)
- $contentType : string = self::contentTypes['createTemplate'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTemplate'] to see the possible values for this operation
Tags
Return values
Request —createTemplateWithHttpInfo()
Operation createTemplateWithHttpInfo
public
createTemplateWithHttpInfo(CreateTemplateOptions $create_template_options[, string $contentType = self::contentTypes['createTemplate'][0] ]) : array<string|int, mixed>
Create a Template
Parameters
- $create_template_options : CreateTemplateOptions
-
(required)
- $contentType : string = self::contentTypes['createTemplate'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTemplate'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\TemplateDto, HTTP status code, HTTP response headers (array of strings)
deleteTemplate()
Operation deleteTemplate
public
deleteTemplate(string $template_id[, string $contentType = self::contentTypes['deleteTemplate'][0] ]) : void
Delete email template
Parameters
- $template_id : string
-
Template ID (required)
- $contentType : string = self::contentTypes['deleteTemplate'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteTemplate'] to see the possible values for this operation
Tags
Return values
void —deleteTemplateAsync()
Operation deleteTemplateAsync
public
deleteTemplateAsync(string $template_id[, string $contentType = self::contentTypes['deleteTemplate'][0] ]) : PromiseInterface
Delete email template
Parameters
- $template_id : string
-
Template ID (required)
- $contentType : string = self::contentTypes['deleteTemplate'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteTemplate'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteTemplateAsyncWithHttpInfo()
Operation deleteTemplateAsyncWithHttpInfo
public
deleteTemplateAsyncWithHttpInfo(string $template_id[, string $contentType = self::contentTypes['deleteTemplate'][0] ]) : PromiseInterface
Delete email template
Parameters
- $template_id : string
-
Template ID (required)
- $contentType : string = self::contentTypes['deleteTemplate'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteTemplate'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteTemplateRequest()
Create request for operation 'deleteTemplate'
public
deleteTemplateRequest(string $template_id[, string $contentType = self::contentTypes['deleteTemplate'][0] ]) : Request
Parameters
- $template_id : string
-
Template ID (required)
- $contentType : string = self::contentTypes['deleteTemplate'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteTemplate'] to see the possible values for this operation
Tags
Return values
Request —deleteTemplateWithHttpInfo()
Operation deleteTemplateWithHttpInfo
public
deleteTemplateWithHttpInfo(string $template_id[, string $contentType = self::contentTypes['deleteTemplate'][0] ]) : array<string|int, mixed>
Delete email template
Parameters
- $template_id : string
-
Template ID (required)
- $contentType : string = self::contentTypes['deleteTemplate'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteTemplate'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getAllTemplates()
Operation getAllTemplates
public
getAllTemplates(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllTemplates'][0] ]) : PageTemplateProjection
List templates
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')
- $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['getAllTemplates'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllTemplates'] to see the possible values for this operation
Tags
Return values
PageTemplateProjection —getAllTemplatesAsync()
Operation getAllTemplatesAsync
public
getAllTemplatesAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllTemplates'][0] ]) : PromiseInterface
List templates
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')
- $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['getAllTemplates'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllTemplates'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllTemplatesAsyncWithHttpInfo()
Operation getAllTemplatesAsyncWithHttpInfo
public
getAllTemplatesAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllTemplates'][0] ]) : PromiseInterface
List templates
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')
- $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['getAllTemplates'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllTemplates'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllTemplatesRequest()
Create request for operation 'getAllTemplates'
public
getAllTemplatesRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllTemplates'][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')
- $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['getAllTemplates'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllTemplates'] to see the possible values for this operation
Tags
Return values
Request —getAllTemplatesWithHttpInfo()
Operation getAllTemplatesWithHttpInfo
public
getAllTemplatesWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllTemplates'][0] ]) : array<string|int, mixed>
List templates
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')
- $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['getAllTemplates'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllTemplates'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageTemplateProjection, 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
getTemplate()
Operation getTemplate
public
getTemplate(string $template_id[, string $contentType = self::contentTypes['getTemplate'][0] ]) : TemplateDto
Get template
Parameters
- $template_id : string
-
Template ID (required)
- $contentType : string = self::contentTypes['getTemplate'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTemplate'] to see the possible values for this operation
Tags
Return values
TemplateDto —getTemplateAsync()
Operation getTemplateAsync
public
getTemplateAsync(string $template_id[, string $contentType = self::contentTypes['getTemplate'][0] ]) : PromiseInterface
Get template
Parameters
- $template_id : string
-
Template ID (required)
- $contentType : string = self::contentTypes['getTemplate'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTemplate'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTemplateAsyncWithHttpInfo()
Operation getTemplateAsyncWithHttpInfo
public
getTemplateAsyncWithHttpInfo(string $template_id[, string $contentType = self::contentTypes['getTemplate'][0] ]) : PromiseInterface
Get template
Parameters
- $template_id : string
-
Template ID (required)
- $contentType : string = self::contentTypes['getTemplate'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTemplate'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTemplatePreviewHtml()
Operation getTemplatePreviewHtml
public
getTemplatePreviewHtml(string $template_id[, string $contentType = self::contentTypes['getTemplatePreviewHtml'][0] ]) : string
Get template preview HTML
Parameters
- $template_id : string
-
Template ID (required)
- $contentType : string = self::contentTypes['getTemplatePreviewHtml'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTemplatePreviewHtml'] to see the possible values for this operation
Tags
Return values
string —getTemplatePreviewHtmlAsync()
Operation getTemplatePreviewHtmlAsync
public
getTemplatePreviewHtmlAsync(string $template_id[, string $contentType = self::contentTypes['getTemplatePreviewHtml'][0] ]) : PromiseInterface
Get template preview HTML
Parameters
- $template_id : string
-
Template ID (required)
- $contentType : string = self::contentTypes['getTemplatePreviewHtml'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTemplatePreviewHtml'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTemplatePreviewHtmlAsyncWithHttpInfo()
Operation getTemplatePreviewHtmlAsyncWithHttpInfo
public
getTemplatePreviewHtmlAsyncWithHttpInfo(string $template_id[, string $contentType = self::contentTypes['getTemplatePreviewHtml'][0] ]) : PromiseInterface
Get template preview HTML
Parameters
- $template_id : string
-
Template ID (required)
- $contentType : string = self::contentTypes['getTemplatePreviewHtml'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTemplatePreviewHtml'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTemplatePreviewHtmlRequest()
Create request for operation 'getTemplatePreviewHtml'
public
getTemplatePreviewHtmlRequest(string $template_id[, string $contentType = self::contentTypes['getTemplatePreviewHtml'][0] ]) : Request
Parameters
- $template_id : string
-
Template ID (required)
- $contentType : string = self::contentTypes['getTemplatePreviewHtml'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTemplatePreviewHtml'] to see the possible values for this operation
Tags
Return values
Request —getTemplatePreviewHtmlWithHttpInfo()
Operation getTemplatePreviewHtmlWithHttpInfo
public
getTemplatePreviewHtmlWithHttpInfo(string $template_id[, string $contentType = self::contentTypes['getTemplatePreviewHtml'][0] ]) : array<string|int, mixed>
Get template preview HTML
Parameters
- $template_id : string
-
Template ID (required)
- $contentType : string = self::contentTypes['getTemplatePreviewHtml'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTemplatePreviewHtml'] 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)
getTemplatePreviewJson()
Operation getTemplatePreviewJson
public
getTemplatePreviewJson(string $template_id[, string $contentType = self::contentTypes['getTemplatePreviewJson'][0] ]) : TemplatePreview
Get template preview Json
Parameters
- $template_id : string
-
Template ID (required)
- $contentType : string = self::contentTypes['getTemplatePreviewJson'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTemplatePreviewJson'] to see the possible values for this operation
Tags
Return values
TemplatePreview —getTemplatePreviewJsonAsync()
Operation getTemplatePreviewJsonAsync
public
getTemplatePreviewJsonAsync(string $template_id[, string $contentType = self::contentTypes['getTemplatePreviewJson'][0] ]) : PromiseInterface
Get template preview Json
Parameters
- $template_id : string
-
Template ID (required)
- $contentType : string = self::contentTypes['getTemplatePreviewJson'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTemplatePreviewJson'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTemplatePreviewJsonAsyncWithHttpInfo()
Operation getTemplatePreviewJsonAsyncWithHttpInfo
public
getTemplatePreviewJsonAsyncWithHttpInfo(string $template_id[, string $contentType = self::contentTypes['getTemplatePreviewJson'][0] ]) : PromiseInterface
Get template preview Json
Parameters
- $template_id : string
-
Template ID (required)
- $contentType : string = self::contentTypes['getTemplatePreviewJson'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTemplatePreviewJson'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTemplatePreviewJsonRequest()
Create request for operation 'getTemplatePreviewJson'
public
getTemplatePreviewJsonRequest(string $template_id[, string $contentType = self::contentTypes['getTemplatePreviewJson'][0] ]) : Request
Parameters
- $template_id : string
-
Template ID (required)
- $contentType : string = self::contentTypes['getTemplatePreviewJson'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTemplatePreviewJson'] to see the possible values for this operation
Tags
Return values
Request —getTemplatePreviewJsonWithHttpInfo()
Operation getTemplatePreviewJsonWithHttpInfo
public
getTemplatePreviewJsonWithHttpInfo(string $template_id[, string $contentType = self::contentTypes['getTemplatePreviewJson'][0] ]) : array<string|int, mixed>
Get template preview Json
Parameters
- $template_id : string
-
Template ID (required)
- $contentType : string = self::contentTypes['getTemplatePreviewJson'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTemplatePreviewJson'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\TemplatePreview, HTTP status code, HTTP response headers (array of strings)
getTemplateRequest()
Create request for operation 'getTemplate'
public
getTemplateRequest(string $template_id[, string $contentType = self::contentTypes['getTemplate'][0] ]) : Request
Parameters
- $template_id : string
-
Template ID (required)
- $contentType : string = self::contentTypes['getTemplate'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTemplate'] to see the possible values for this operation
Tags
Return values
Request —getTemplates()
Operation getTemplates
public
getTemplates([string $contentType = self::contentTypes['getTemplates'][0] ]) : array<string|int, TemplateProjection>
List templates
Parameters
- $contentType : string = self::contentTypes['getTemplates'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTemplates'] to see the possible values for this operation
Tags
Return values
array<string|int, TemplateProjection> —getTemplatesAsync()
Operation getTemplatesAsync
public
getTemplatesAsync([string $contentType = self::contentTypes['getTemplates'][0] ]) : PromiseInterface
List templates
Parameters
- $contentType : string = self::contentTypes['getTemplates'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTemplates'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTemplatesAsyncWithHttpInfo()
Operation getTemplatesAsyncWithHttpInfo
public
getTemplatesAsyncWithHttpInfo([string $contentType = self::contentTypes['getTemplates'][0] ]) : PromiseInterface
List templates
Parameters
- $contentType : string = self::contentTypes['getTemplates'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTemplates'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTemplatesRequest()
Create request for operation 'getTemplates'
public
getTemplatesRequest([string $contentType = self::contentTypes['getTemplates'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['getTemplates'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTemplates'] to see the possible values for this operation
Tags
Return values
Request —getTemplatesWithHttpInfo()
Operation getTemplatesWithHttpInfo
public
getTemplatesWithHttpInfo([string $contentType = self::contentTypes['getTemplates'][0] ]) : array<string|int, mixed>
List templates
Parameters
- $contentType : string = self::contentTypes['getTemplates'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTemplates'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\TemplateProjection[], HTTP status code, HTTP response headers (array of strings)
getTemplateWithHttpInfo()
Operation getTemplateWithHttpInfo
public
getTemplateWithHttpInfo(string $template_id[, string $contentType = self::contentTypes['getTemplate'][0] ]) : array<string|int, mixed>
Get template
Parameters
- $template_id : string
-
Template ID (required)
- $contentType : string = self::contentTypes['getTemplate'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTemplate'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\TemplateDto, 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 —updateTemplate()
Operation updateTemplate
public
updateTemplate(string $template_id, CreateTemplateOptions $create_template_options[, string $contentType = self::contentTypes['updateTemplate'][0] ]) : TemplateDto
Update template
Parameters
- $template_id : string
-
Template ID (required)
- $create_template_options : CreateTemplateOptions
-
create_template_options (required)
- $contentType : string = self::contentTypes['updateTemplate'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateTemplate'] to see the possible values for this operation
Tags
Return values
TemplateDto —updateTemplateAsync()
Operation updateTemplateAsync
public
updateTemplateAsync(string $template_id, CreateTemplateOptions $create_template_options[, string $contentType = self::contentTypes['updateTemplate'][0] ]) : PromiseInterface
Update template
Parameters
- $template_id : string
-
Template ID (required)
- $create_template_options : CreateTemplateOptions
-
(required)
- $contentType : string = self::contentTypes['updateTemplate'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateTemplate'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateTemplateAsyncWithHttpInfo()
Operation updateTemplateAsyncWithHttpInfo
public
updateTemplateAsyncWithHttpInfo(string $template_id, CreateTemplateOptions $create_template_options[, string $contentType = self::contentTypes['updateTemplate'][0] ]) : PromiseInterface
Update template
Parameters
- $template_id : string
-
Template ID (required)
- $create_template_options : CreateTemplateOptions
-
(required)
- $contentType : string = self::contentTypes['updateTemplate'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateTemplate'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateTemplateRequest()
Create request for operation 'updateTemplate'
public
updateTemplateRequest(string $template_id, CreateTemplateOptions $create_template_options[, string $contentType = self::contentTypes['updateTemplate'][0] ]) : Request
Parameters
- $template_id : string
-
Template ID (required)
- $create_template_options : CreateTemplateOptions
-
(required)
- $contentType : string = self::contentTypes['updateTemplate'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateTemplate'] to see the possible values for this operation
Tags
Return values
Request —updateTemplateWithHttpInfo()
Operation updateTemplateWithHttpInfo
public
updateTemplateWithHttpInfo(string $template_id, CreateTemplateOptions $create_template_options[, string $contentType = self::contentTypes['updateTemplate'][0] ]) : array<string|int, mixed>
Update template
Parameters
- $template_id : string
-
Template ID (required)
- $create_template_options : CreateTemplateOptions
-
(required)
- $contentType : string = self::contentTypes['updateTemplate'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateTemplate'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\TemplateDto, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options