AIControllerApi
in package
AIControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['createTransformer' => ['application/json'], 'createTransformerMappings' => ['application/json'], 'deleteAllTransformerMappings' => ['application/json'], 'deleteTransformer' => ['application/json'], 'deleteTransformerMapping' => ['application/json'], 'deleteTransformers' => ['application/json'], 'generateStructuredContentFromAttachment' => ['application/json'], 'generateStructuredContentFromEmail' => ['application/json'], 'generateStructuredContentFromSms' => ['application/json'], 'getTransformer' => ['application/json'], 'getTransformerMapping' => ['application/json'], 'getTransformerMappings' => ['application/json'], 'getTransformerResult' => ['application/json'], 'getTransformerResults' => ['application/json'], 'getTransformers' => ['application/json'], 'invokeTransformer' => ['application/json'], 'validateStructuredOutputSchema' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- createTransformer() : AITransformDto
- Operation createTransformer
- createTransformerAsync() : PromiseInterface
- Operation createTransformerAsync
- createTransformerAsyncWithHttpInfo() : PromiseInterface
- Operation createTransformerAsyncWithHttpInfo
- createTransformerMappings() : AITransformMappingDto
- Operation createTransformerMappings
- createTransformerMappingsAsync() : PromiseInterface
- Operation createTransformerMappingsAsync
- createTransformerMappingsAsyncWithHttpInfo() : PromiseInterface
- Operation createTransformerMappingsAsyncWithHttpInfo
- createTransformerMappingsRequest() : Request
- Create request for operation 'createTransformerMappings'
- createTransformerMappingsWithHttpInfo() : array<string|int, mixed>
- Operation createTransformerMappingsWithHttpInfo
- createTransformerRequest() : Request
- Create request for operation 'createTransformer'
- createTransformerWithHttpInfo() : array<string|int, mixed>
- Operation createTransformerWithHttpInfo
- deleteAllTransformerMappings() : void
- Operation deleteAllTransformerMappings
- deleteAllTransformerMappingsAsync() : PromiseInterface
- Operation deleteAllTransformerMappingsAsync
- deleteAllTransformerMappingsAsyncWithHttpInfo() : PromiseInterface
- Operation deleteAllTransformerMappingsAsyncWithHttpInfo
- deleteAllTransformerMappingsRequest() : Request
- Create request for operation 'deleteAllTransformerMappings'
- deleteAllTransformerMappingsWithHttpInfo() : array<string|int, mixed>
- Operation deleteAllTransformerMappingsWithHttpInfo
- deleteTransformer() : void
- Operation deleteTransformer
- deleteTransformerAsync() : PromiseInterface
- Operation deleteTransformerAsync
- deleteTransformerAsyncWithHttpInfo() : PromiseInterface
- Operation deleteTransformerAsyncWithHttpInfo
- deleteTransformerMapping() : void
- Operation deleteTransformerMapping
- deleteTransformerMappingAsync() : PromiseInterface
- Operation deleteTransformerMappingAsync
- deleteTransformerMappingAsyncWithHttpInfo() : PromiseInterface
- Operation deleteTransformerMappingAsyncWithHttpInfo
- deleteTransformerMappingRequest() : Request
- Create request for operation 'deleteTransformerMapping'
- deleteTransformerMappingWithHttpInfo() : array<string|int, mixed>
- Operation deleteTransformerMappingWithHttpInfo
- deleteTransformerRequest() : Request
- Create request for operation 'deleteTransformer'
- deleteTransformers() : void
- Operation deleteTransformers
- deleteTransformersAsync() : PromiseInterface
- Operation deleteTransformersAsync
- deleteTransformersAsyncWithHttpInfo() : PromiseInterface
- Operation deleteTransformersAsyncWithHttpInfo
- deleteTransformersRequest() : Request
- Create request for operation 'deleteTransformers'
- deleteTransformersWithHttpInfo() : array<string|int, mixed>
- Operation deleteTransformersWithHttpInfo
- deleteTransformerWithHttpInfo() : array<string|int, mixed>
- Operation deleteTransformerWithHttpInfo
- generateStructuredContentFromAttachment() : StructuredContentResultDto
- Operation generateStructuredContentFromAttachment
- generateStructuredContentFromAttachmentAsync() : PromiseInterface
- Operation generateStructuredContentFromAttachmentAsync
- generateStructuredContentFromAttachmentAsyncWithHttpInfo() : PromiseInterface
- Operation generateStructuredContentFromAttachmentAsyncWithHttpInfo
- generateStructuredContentFromAttachmentRequest() : Request
- Create request for operation 'generateStructuredContentFromAttachment'
- generateStructuredContentFromAttachmentWithHttpInfo() : array<string|int, mixed>
- Operation generateStructuredContentFromAttachmentWithHttpInfo
- generateStructuredContentFromEmail() : StructuredContentResultDto
- Operation generateStructuredContentFromEmail
- generateStructuredContentFromEmailAsync() : PromiseInterface
- Operation generateStructuredContentFromEmailAsync
- generateStructuredContentFromEmailAsyncWithHttpInfo() : PromiseInterface
- Operation generateStructuredContentFromEmailAsyncWithHttpInfo
- generateStructuredContentFromEmailRequest() : Request
- Create request for operation 'generateStructuredContentFromEmail'
- generateStructuredContentFromEmailWithHttpInfo() : array<string|int, mixed>
- Operation generateStructuredContentFromEmailWithHttpInfo
- generateStructuredContentFromSms() : StructuredContentResultDto
- Operation generateStructuredContentFromSms
- generateStructuredContentFromSmsAsync() : PromiseInterface
- Operation generateStructuredContentFromSmsAsync
- generateStructuredContentFromSmsAsyncWithHttpInfo() : PromiseInterface
- Operation generateStructuredContentFromSmsAsyncWithHttpInfo
- generateStructuredContentFromSmsRequest() : Request
- Create request for operation 'generateStructuredContentFromSms'
- generateStructuredContentFromSmsWithHttpInfo() : array<string|int, mixed>
- Operation generateStructuredContentFromSmsWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- getTransformer() : AITransformDto
- Operation getTransformer
- getTransformerAsync() : PromiseInterface
- Operation getTransformerAsync
- getTransformerAsyncWithHttpInfo() : PromiseInterface
- Operation getTransformerAsyncWithHttpInfo
- getTransformerMapping() : AITransformMappingDto
- Operation getTransformerMapping
- getTransformerMappingAsync() : PromiseInterface
- Operation getTransformerMappingAsync
- getTransformerMappingAsyncWithHttpInfo() : PromiseInterface
- Operation getTransformerMappingAsyncWithHttpInfo
- getTransformerMappingRequest() : Request
- Create request for operation 'getTransformerMapping'
- getTransformerMappings() : PageAITransformMappingProjection
- Operation getTransformerMappings
- getTransformerMappingsAsync() : PromiseInterface
- Operation getTransformerMappingsAsync
- getTransformerMappingsAsyncWithHttpInfo() : PromiseInterface
- Operation getTransformerMappingsAsyncWithHttpInfo
- getTransformerMappingsRequest() : Request
- Create request for operation 'getTransformerMappings'
- getTransformerMappingsWithHttpInfo() : array<string|int, mixed>
- Operation getTransformerMappingsWithHttpInfo
- getTransformerMappingWithHttpInfo() : array<string|int, mixed>
- Operation getTransformerMappingWithHttpInfo
- getTransformerRequest() : Request
- Create request for operation 'getTransformer'
- getTransformerResult() : AITransformResultDto
- Operation getTransformerResult
- getTransformerResultAsync() : PromiseInterface
- Operation getTransformerResultAsync
- getTransformerResultAsyncWithHttpInfo() : PromiseInterface
- Operation getTransformerResultAsyncWithHttpInfo
- getTransformerResultRequest() : Request
- Create request for operation 'getTransformerResult'
- getTransformerResults() : PageAITransformResultProjection
- Operation getTransformerResults
- getTransformerResultsAsync() : PromiseInterface
- Operation getTransformerResultsAsync
- getTransformerResultsAsyncWithHttpInfo() : PromiseInterface
- Operation getTransformerResultsAsyncWithHttpInfo
- getTransformerResultsRequest() : Request
- Create request for operation 'getTransformerResults'
- getTransformerResultsWithHttpInfo() : array<string|int, mixed>
- Operation getTransformerResultsWithHttpInfo
- getTransformerResultWithHttpInfo() : array<string|int, mixed>
- Operation getTransformerResultWithHttpInfo
- getTransformers() : PageAITransformProjection
- Operation getTransformers
- getTransformersAsync() : PromiseInterface
- Operation getTransformersAsync
- getTransformersAsyncWithHttpInfo() : PromiseInterface
- Operation getTransformersAsyncWithHttpInfo
- getTransformersRequest() : Request
- Create request for operation 'getTransformers'
- getTransformersWithHttpInfo() : array<string|int, mixed>
- Operation getTransformersWithHttpInfo
- getTransformerWithHttpInfo() : array<string|int, mixed>
- Operation getTransformerWithHttpInfo
- invokeTransformer() : ConditionalStructuredContentResult
- Operation invokeTransformer
- invokeTransformerAsync() : PromiseInterface
- Operation invokeTransformerAsync
- invokeTransformerAsyncWithHttpInfo() : PromiseInterface
- Operation invokeTransformerAsyncWithHttpInfo
- invokeTransformerRequest() : Request
- Create request for operation 'invokeTransformer'
- invokeTransformerWithHttpInfo() : array<string|int, mixed>
- Operation invokeTransformerWithHttpInfo
- setHostIndex() : void
- Set the host index
- validateStructuredOutputSchema() : StructuredOutputSchemaValidation
- Operation validateStructuredOutputSchema
- validateStructuredOutputSchemaAsync() : PromiseInterface
- Operation validateStructuredOutputSchemaAsync
- validateStructuredOutputSchemaAsyncWithHttpInfo() : PromiseInterface
- Operation validateStructuredOutputSchemaAsyncWithHttpInfo
- validateStructuredOutputSchemaRequest() : Request
- Create request for operation 'validateStructuredOutputSchema'
- validateStructuredOutputSchemaWithHttpInfo() : array<string|int, mixed>
- Operation validateStructuredOutputSchemaWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['createTransformer' => ['application/json'], 'createTransformerMappings' => ['application/json'], 'deleteAllTransformerMappings' => ['application/json'], 'deleteTransformer' => ['application/json'], 'deleteTransformerMapping' => ['application/json'], 'deleteTransformers' => ['application/json'], 'generateStructuredContentFromAttachment' => ['application/json'], 'generateStructuredContentFromEmail' => ['application/json'], 'generateStructuredContentFromSms' => ['application/json'], 'getTransformer' => ['application/json'], 'getTransformerMapping' => ['application/json'], 'getTransformerMappings' => ['application/json'], 'getTransformerResult' => ['application/json'], 'getTransformerResults' => ['application/json'], 'getTransformers' => ['application/json'], 'invokeTransformer' => ['application/json'], 'validateStructuredOutputSchema' => ['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 —createTransformer()
Operation createTransformer
public
createTransformer(AITransformCreateOptions $ai_transform_create_options[, string $contentType = self::contentTypes['createTransformer'][0] ]) : AITransformDto
Create a transformer for reuse in automations
Parameters
- $ai_transform_create_options : AITransformCreateOptions
-
ai_transform_create_options (required)
- $contentType : string = self::contentTypes['createTransformer'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTransformer'] to see the possible values for this operation
Tags
Return values
AITransformDto —createTransformerAsync()
Operation createTransformerAsync
public
createTransformerAsync(AITransformCreateOptions $ai_transform_create_options[, string $contentType = self::contentTypes['createTransformer'][0] ]) : PromiseInterface
Create a transformer for reuse in automations
Parameters
- $ai_transform_create_options : AITransformCreateOptions
-
(required)
- $contentType : string = self::contentTypes['createTransformer'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTransformer'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createTransformerAsyncWithHttpInfo()
Operation createTransformerAsyncWithHttpInfo
public
createTransformerAsyncWithHttpInfo(AITransformCreateOptions $ai_transform_create_options[, string $contentType = self::contentTypes['createTransformer'][0] ]) : PromiseInterface
Create a transformer for reuse in automations
Parameters
- $ai_transform_create_options : AITransformCreateOptions
-
(required)
- $contentType : string = self::contentTypes['createTransformer'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTransformer'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createTransformerMappings()
Operation createTransformerMappings
public
createTransformerMappings(CreateAITransformerMappingOptions $create_ai_transformer_mapping_options[, string $contentType = self::contentTypes['createTransformerMappings'][0] ]) : AITransformMappingDto
Create transformer mapping
Parameters
- $create_ai_transformer_mapping_options : CreateAITransformerMappingOptions
-
create_ai_transformer_mapping_options (required)
- $contentType : string = self::contentTypes['createTransformerMappings'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTransformerMappings'] to see the possible values for this operation
Tags
Return values
AITransformMappingDto —createTransformerMappingsAsync()
Operation createTransformerMappingsAsync
public
createTransformerMappingsAsync(CreateAITransformerMappingOptions $create_ai_transformer_mapping_options[, string $contentType = self::contentTypes['createTransformerMappings'][0] ]) : PromiseInterface
Create transformer mapping
Parameters
- $create_ai_transformer_mapping_options : CreateAITransformerMappingOptions
-
(required)
- $contentType : string = self::contentTypes['createTransformerMappings'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTransformerMappings'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createTransformerMappingsAsyncWithHttpInfo()
Operation createTransformerMappingsAsyncWithHttpInfo
public
createTransformerMappingsAsyncWithHttpInfo(CreateAITransformerMappingOptions $create_ai_transformer_mapping_options[, string $contentType = self::contentTypes['createTransformerMappings'][0] ]) : PromiseInterface
Create transformer mapping
Parameters
- $create_ai_transformer_mapping_options : CreateAITransformerMappingOptions
-
(required)
- $contentType : string = self::contentTypes['createTransformerMappings'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTransformerMappings'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createTransformerMappingsRequest()
Create request for operation 'createTransformerMappings'
public
createTransformerMappingsRequest(CreateAITransformerMappingOptions $create_ai_transformer_mapping_options[, string $contentType = self::contentTypes['createTransformerMappings'][0] ]) : Request
Parameters
- $create_ai_transformer_mapping_options : CreateAITransformerMappingOptions
-
(required)
- $contentType : string = self::contentTypes['createTransformerMappings'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTransformerMappings'] to see the possible values for this operation
Tags
Return values
Request —createTransformerMappingsWithHttpInfo()
Operation createTransformerMappingsWithHttpInfo
public
createTransformerMappingsWithHttpInfo(CreateAITransformerMappingOptions $create_ai_transformer_mapping_options[, string $contentType = self::contentTypes['createTransformerMappings'][0] ]) : array<string|int, mixed>
Create transformer mapping
Parameters
- $create_ai_transformer_mapping_options : CreateAITransformerMappingOptions
-
(required)
- $contentType : string = self::contentTypes['createTransformerMappings'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTransformerMappings'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\AITransformMappingDto, HTTP status code, HTTP response headers (array of strings)
createTransformerRequest()
Create request for operation 'createTransformer'
public
createTransformerRequest(AITransformCreateOptions $ai_transform_create_options[, string $contentType = self::contentTypes['createTransformer'][0] ]) : Request
Parameters
- $ai_transform_create_options : AITransformCreateOptions
-
(required)
- $contentType : string = self::contentTypes['createTransformer'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTransformer'] to see the possible values for this operation
Tags
Return values
Request —createTransformerWithHttpInfo()
Operation createTransformerWithHttpInfo
public
createTransformerWithHttpInfo(AITransformCreateOptions $ai_transform_create_options[, string $contentType = self::contentTypes['createTransformer'][0] ]) : array<string|int, mixed>
Create a transformer for reuse in automations
Parameters
- $ai_transform_create_options : AITransformCreateOptions
-
(required)
- $contentType : string = self::contentTypes['createTransformer'][0]
-
The value for the Content-Type header. Check self::contentTypes['createTransformer'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\AITransformDto, HTTP status code, HTTP response headers (array of strings)
deleteAllTransformerMappings()
Operation deleteAllTransformerMappings
public
deleteAllTransformerMappings([string $contentType = self::contentTypes['deleteAllTransformerMappings'][0] ]) : void
Delete all transformer mapping
Parameters
- $contentType : string = self::contentTypes['deleteAllTransformerMappings'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllTransformerMappings'] to see the possible values for this operation
Tags
Return values
void —deleteAllTransformerMappingsAsync()
Operation deleteAllTransformerMappingsAsync
public
deleteAllTransformerMappingsAsync([string $contentType = self::contentTypes['deleteAllTransformerMappings'][0] ]) : PromiseInterface
Delete all transformer mapping
Parameters
- $contentType : string = self::contentTypes['deleteAllTransformerMappings'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllTransformerMappings'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteAllTransformerMappingsAsyncWithHttpInfo()
Operation deleteAllTransformerMappingsAsyncWithHttpInfo
public
deleteAllTransformerMappingsAsyncWithHttpInfo([string $contentType = self::contentTypes['deleteAllTransformerMappings'][0] ]) : PromiseInterface
Delete all transformer mapping
Parameters
- $contentType : string = self::contentTypes['deleteAllTransformerMappings'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllTransformerMappings'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteAllTransformerMappingsRequest()
Create request for operation 'deleteAllTransformerMappings'
public
deleteAllTransformerMappingsRequest([string $contentType = self::contentTypes['deleteAllTransformerMappings'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['deleteAllTransformerMappings'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllTransformerMappings'] to see the possible values for this operation
Tags
Return values
Request —deleteAllTransformerMappingsWithHttpInfo()
Operation deleteAllTransformerMappingsWithHttpInfo
public
deleteAllTransformerMappingsWithHttpInfo([string $contentType = self::contentTypes['deleteAllTransformerMappings'][0] ]) : array<string|int, mixed>
Delete all transformer mapping
Parameters
- $contentType : string = self::contentTypes['deleteAllTransformerMappings'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllTransformerMappings'] 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)
deleteTransformer()
Operation deleteTransformer
public
deleteTransformer(string $id[, string $contentType = self::contentTypes['deleteTransformer'][0] ]) : void
Delete a transformer
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['deleteTransformer'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteTransformer'] to see the possible values for this operation
Tags
Return values
void —deleteTransformerAsync()
Operation deleteTransformerAsync
public
deleteTransformerAsync(string $id[, string $contentType = self::contentTypes['deleteTransformer'][0] ]) : PromiseInterface
Delete a transformer
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteTransformer'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteTransformer'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteTransformerAsyncWithHttpInfo()
Operation deleteTransformerAsyncWithHttpInfo
public
deleteTransformerAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteTransformer'][0] ]) : PromiseInterface
Delete a transformer
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteTransformer'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteTransformer'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteTransformerMapping()
Operation deleteTransformerMapping
public
deleteTransformerMapping(string $id[, string $contentType = self::contentTypes['deleteTransformerMapping'][0] ]) : void
Delete transformer mapping
Parameters
- $id : string
-
ID of transform mapping (required)
- $contentType : string = self::contentTypes['deleteTransformerMapping'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteTransformerMapping'] to see the possible values for this operation
Tags
Return values
void —deleteTransformerMappingAsync()
Operation deleteTransformerMappingAsync
public
deleteTransformerMappingAsync(string $id[, string $contentType = self::contentTypes['deleteTransformerMapping'][0] ]) : PromiseInterface
Delete transformer mapping
Parameters
- $id : string
-
ID of transform mapping (required)
- $contentType : string = self::contentTypes['deleteTransformerMapping'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteTransformerMapping'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteTransformerMappingAsyncWithHttpInfo()
Operation deleteTransformerMappingAsyncWithHttpInfo
public
deleteTransformerMappingAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteTransformerMapping'][0] ]) : PromiseInterface
Delete transformer mapping
Parameters
- $id : string
-
ID of transform mapping (required)
- $contentType : string = self::contentTypes['deleteTransformerMapping'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteTransformerMapping'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteTransformerMappingRequest()
Create request for operation 'deleteTransformerMapping'
public
deleteTransformerMappingRequest(string $id[, string $contentType = self::contentTypes['deleteTransformerMapping'][0] ]) : Request
Parameters
- $id : string
-
ID of transform mapping (required)
- $contentType : string = self::contentTypes['deleteTransformerMapping'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteTransformerMapping'] to see the possible values for this operation
Tags
Return values
Request —deleteTransformerMappingWithHttpInfo()
Operation deleteTransformerMappingWithHttpInfo
public
deleteTransformerMappingWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteTransformerMapping'][0] ]) : array<string|int, mixed>
Delete transformer mapping
Parameters
- $id : string
-
ID of transform mapping (required)
- $contentType : string = self::contentTypes['deleteTransformerMapping'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteTransformerMapping'] 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)
deleteTransformerRequest()
Create request for operation 'deleteTransformer'
public
deleteTransformerRequest(string $id[, string $contentType = self::contentTypes['deleteTransformer'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteTransformer'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteTransformer'] to see the possible values for this operation
Tags
Return values
Request —deleteTransformers()
Operation deleteTransformers
public
deleteTransformers([string $contentType = self::contentTypes['deleteTransformers'][0] ]) : void
Delete all transformers
Parameters
- $contentType : string = self::contentTypes['deleteTransformers'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteTransformers'] to see the possible values for this operation
Tags
Return values
void —deleteTransformersAsync()
Operation deleteTransformersAsync
public
deleteTransformersAsync([string $contentType = self::contentTypes['deleteTransformers'][0] ]) : PromiseInterface
Delete all transformers
Parameters
- $contentType : string = self::contentTypes['deleteTransformers'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteTransformers'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteTransformersAsyncWithHttpInfo()
Operation deleteTransformersAsyncWithHttpInfo
public
deleteTransformersAsyncWithHttpInfo([string $contentType = self::contentTypes['deleteTransformers'][0] ]) : PromiseInterface
Delete all transformers
Parameters
- $contentType : string = self::contentTypes['deleteTransformers'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteTransformers'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteTransformersRequest()
Create request for operation 'deleteTransformers'
public
deleteTransformersRequest([string $contentType = self::contentTypes['deleteTransformers'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['deleteTransformers'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteTransformers'] to see the possible values for this operation
Tags
Return values
Request —deleteTransformersWithHttpInfo()
Operation deleteTransformersWithHttpInfo
public
deleteTransformersWithHttpInfo([string $contentType = self::contentTypes['deleteTransformers'][0] ]) : array<string|int, mixed>
Delete all transformers
Parameters
- $contentType : string = self::contentTypes['deleteTransformers'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteTransformers'] 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)
deleteTransformerWithHttpInfo()
Operation deleteTransformerWithHttpInfo
public
deleteTransformerWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteTransformer'][0] ]) : array<string|int, mixed>
Delete a transformer
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteTransformer'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteTransformer'] 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)
generateStructuredContentFromAttachment()
Operation generateStructuredContentFromAttachment
public
generateStructuredContentFromAttachment(GenerateStructuredContentAttachmentOptions $generate_structured_content_attachment_options[, string $contentType = self::contentTypes['generateStructuredContentFromAttachment'][0] ]) : StructuredContentResultDto
Generate structured content for an attachment
Parameters
- $generate_structured_content_attachment_options : GenerateStructuredContentAttachmentOptions
-
generate_structured_content_attachment_options (required)
- $contentType : string = self::contentTypes['generateStructuredContentFromAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromAttachment'] to see the possible values for this operation
Tags
Return values
StructuredContentResultDto —generateStructuredContentFromAttachmentAsync()
Operation generateStructuredContentFromAttachmentAsync
public
generateStructuredContentFromAttachmentAsync(GenerateStructuredContentAttachmentOptions $generate_structured_content_attachment_options[, string $contentType = self::contentTypes['generateStructuredContentFromAttachment'][0] ]) : PromiseInterface
Generate structured content for an attachment
Parameters
- $generate_structured_content_attachment_options : GenerateStructuredContentAttachmentOptions
-
(required)
- $contentType : string = self::contentTypes['generateStructuredContentFromAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromAttachment'] to see the possible values for this operation
Tags
Return values
PromiseInterface —generateStructuredContentFromAttachmentAsyncWithHttpInfo()
Operation generateStructuredContentFromAttachmentAsyncWithHttpInfo
public
generateStructuredContentFromAttachmentAsyncWithHttpInfo(GenerateStructuredContentAttachmentOptions $generate_structured_content_attachment_options[, string $contentType = self::contentTypes['generateStructuredContentFromAttachment'][0] ]) : PromiseInterface
Generate structured content for an attachment
Parameters
- $generate_structured_content_attachment_options : GenerateStructuredContentAttachmentOptions
-
(required)
- $contentType : string = self::contentTypes['generateStructuredContentFromAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromAttachment'] to see the possible values for this operation
Tags
Return values
PromiseInterface —generateStructuredContentFromAttachmentRequest()
Create request for operation 'generateStructuredContentFromAttachment'
public
generateStructuredContentFromAttachmentRequest(GenerateStructuredContentAttachmentOptions $generate_structured_content_attachment_options[, string $contentType = self::contentTypes['generateStructuredContentFromAttachment'][0] ]) : Request
Parameters
- $generate_structured_content_attachment_options : GenerateStructuredContentAttachmentOptions
-
(required)
- $contentType : string = self::contentTypes['generateStructuredContentFromAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromAttachment'] to see the possible values for this operation
Tags
Return values
Request —generateStructuredContentFromAttachmentWithHttpInfo()
Operation generateStructuredContentFromAttachmentWithHttpInfo
public
generateStructuredContentFromAttachmentWithHttpInfo(GenerateStructuredContentAttachmentOptions $generate_structured_content_attachment_options[, string $contentType = self::contentTypes['generateStructuredContentFromAttachment'][0] ]) : array<string|int, mixed>
Generate structured content for an attachment
Parameters
- $generate_structured_content_attachment_options : GenerateStructuredContentAttachmentOptions
-
(required)
- $contentType : string = self::contentTypes['generateStructuredContentFromAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromAttachment'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\StructuredContentResultDto, HTTP status code, HTTP response headers (array of strings)
generateStructuredContentFromEmail()
Operation generateStructuredContentFromEmail
public
generateStructuredContentFromEmail(GenerateStructuredContentEmailOptions $generate_structured_content_email_options[, string $contentType = self::contentTypes['generateStructuredContentFromEmail'][0] ]) : StructuredContentResultDto
Generate structured content for an email
Parameters
- $generate_structured_content_email_options : GenerateStructuredContentEmailOptions
-
generate_structured_content_email_options (required)
- $contentType : string = self::contentTypes['generateStructuredContentFromEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromEmail'] to see the possible values for this operation
Tags
Return values
StructuredContentResultDto —generateStructuredContentFromEmailAsync()
Operation generateStructuredContentFromEmailAsync
public
generateStructuredContentFromEmailAsync(GenerateStructuredContentEmailOptions $generate_structured_content_email_options[, string $contentType = self::contentTypes['generateStructuredContentFromEmail'][0] ]) : PromiseInterface
Generate structured content for an email
Parameters
- $generate_structured_content_email_options : GenerateStructuredContentEmailOptions
-
(required)
- $contentType : string = self::contentTypes['generateStructuredContentFromEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromEmail'] to see the possible values for this operation
Tags
Return values
PromiseInterface —generateStructuredContentFromEmailAsyncWithHttpInfo()
Operation generateStructuredContentFromEmailAsyncWithHttpInfo
public
generateStructuredContentFromEmailAsyncWithHttpInfo(GenerateStructuredContentEmailOptions $generate_structured_content_email_options[, string $contentType = self::contentTypes['generateStructuredContentFromEmail'][0] ]) : PromiseInterface
Generate structured content for an email
Parameters
- $generate_structured_content_email_options : GenerateStructuredContentEmailOptions
-
(required)
- $contentType : string = self::contentTypes['generateStructuredContentFromEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromEmail'] to see the possible values for this operation
Tags
Return values
PromiseInterface —generateStructuredContentFromEmailRequest()
Create request for operation 'generateStructuredContentFromEmail'
public
generateStructuredContentFromEmailRequest(GenerateStructuredContentEmailOptions $generate_structured_content_email_options[, string $contentType = self::contentTypes['generateStructuredContentFromEmail'][0] ]) : Request
Parameters
- $generate_structured_content_email_options : GenerateStructuredContentEmailOptions
-
(required)
- $contentType : string = self::contentTypes['generateStructuredContentFromEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromEmail'] to see the possible values for this operation
Tags
Return values
Request —generateStructuredContentFromEmailWithHttpInfo()
Operation generateStructuredContentFromEmailWithHttpInfo
public
generateStructuredContentFromEmailWithHttpInfo(GenerateStructuredContentEmailOptions $generate_structured_content_email_options[, string $contentType = self::contentTypes['generateStructuredContentFromEmail'][0] ]) : array<string|int, mixed>
Generate structured content for an email
Parameters
- $generate_structured_content_email_options : GenerateStructuredContentEmailOptions
-
(required)
- $contentType : string = self::contentTypes['generateStructuredContentFromEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromEmail'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\StructuredContentResultDto, HTTP status code, HTTP response headers (array of strings)
generateStructuredContentFromSms()
Operation generateStructuredContentFromSms
public
generateStructuredContentFromSms(GenerateStructuredContentSmsOptions $generate_structured_content_sms_options[, string $contentType = self::contentTypes['generateStructuredContentFromSms'][0] ]) : StructuredContentResultDto
Generate structured content for a TXT message
Parameters
- $generate_structured_content_sms_options : GenerateStructuredContentSmsOptions
-
generate_structured_content_sms_options (required)
- $contentType : string = self::contentTypes['generateStructuredContentFromSms'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromSms'] to see the possible values for this operation
Tags
Return values
StructuredContentResultDto —generateStructuredContentFromSmsAsync()
Operation generateStructuredContentFromSmsAsync
public
generateStructuredContentFromSmsAsync(GenerateStructuredContentSmsOptions $generate_structured_content_sms_options[, string $contentType = self::contentTypes['generateStructuredContentFromSms'][0] ]) : PromiseInterface
Generate structured content for a TXT message
Parameters
- $generate_structured_content_sms_options : GenerateStructuredContentSmsOptions
-
(required)
- $contentType : string = self::contentTypes['generateStructuredContentFromSms'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromSms'] to see the possible values for this operation
Tags
Return values
PromiseInterface —generateStructuredContentFromSmsAsyncWithHttpInfo()
Operation generateStructuredContentFromSmsAsyncWithHttpInfo
public
generateStructuredContentFromSmsAsyncWithHttpInfo(GenerateStructuredContentSmsOptions $generate_structured_content_sms_options[, string $contentType = self::contentTypes['generateStructuredContentFromSms'][0] ]) : PromiseInterface
Generate structured content for a TXT message
Parameters
- $generate_structured_content_sms_options : GenerateStructuredContentSmsOptions
-
(required)
- $contentType : string = self::contentTypes['generateStructuredContentFromSms'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromSms'] to see the possible values for this operation
Tags
Return values
PromiseInterface —generateStructuredContentFromSmsRequest()
Create request for operation 'generateStructuredContentFromSms'
public
generateStructuredContentFromSmsRequest(GenerateStructuredContentSmsOptions $generate_structured_content_sms_options[, string $contentType = self::contentTypes['generateStructuredContentFromSms'][0] ]) : Request
Parameters
- $generate_structured_content_sms_options : GenerateStructuredContentSmsOptions
-
(required)
- $contentType : string = self::contentTypes['generateStructuredContentFromSms'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromSms'] to see the possible values for this operation
Tags
Return values
Request —generateStructuredContentFromSmsWithHttpInfo()
Operation generateStructuredContentFromSmsWithHttpInfo
public
generateStructuredContentFromSmsWithHttpInfo(GenerateStructuredContentSmsOptions $generate_structured_content_sms_options[, string $contentType = self::contentTypes['generateStructuredContentFromSms'][0] ]) : array<string|int, mixed>
Generate structured content for a TXT message
Parameters
- $generate_structured_content_sms_options : GenerateStructuredContentSmsOptions
-
(required)
- $contentType : string = self::contentTypes['generateStructuredContentFromSms'][0]
-
The value for the Content-Type header. Check self::contentTypes['generateStructuredContentFromSms'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\StructuredContentResultDto, 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
getTransformer()
Operation getTransformer
public
getTransformer(string $id[, string $contentType = self::contentTypes['getTransformer'][0] ]) : AITransformDto
Get a transformer
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['getTransformer'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformer'] to see the possible values for this operation
Tags
Return values
AITransformDto —getTransformerAsync()
Operation getTransformerAsync
public
getTransformerAsync(string $id[, string $contentType = self::contentTypes['getTransformer'][0] ]) : PromiseInterface
Get a transformer
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getTransformer'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformer'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTransformerAsyncWithHttpInfo()
Operation getTransformerAsyncWithHttpInfo
public
getTransformerAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getTransformer'][0] ]) : PromiseInterface
Get a transformer
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getTransformer'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformer'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTransformerMapping()
Operation getTransformerMapping
public
getTransformerMapping(string $id[, string $contentType = self::contentTypes['getTransformerMapping'][0] ]) : AITransformMappingDto
Get transformer mapping
Parameters
- $id : string
-
ID of transform mapping (required)
- $contentType : string = self::contentTypes['getTransformerMapping'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformerMapping'] to see the possible values for this operation
Tags
Return values
AITransformMappingDto —getTransformerMappingAsync()
Operation getTransformerMappingAsync
public
getTransformerMappingAsync(string $id[, string $contentType = self::contentTypes['getTransformerMapping'][0] ]) : PromiseInterface
Get transformer mapping
Parameters
- $id : string
-
ID of transform mapping (required)
- $contentType : string = self::contentTypes['getTransformerMapping'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformerMapping'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTransformerMappingAsyncWithHttpInfo()
Operation getTransformerMappingAsyncWithHttpInfo
public
getTransformerMappingAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getTransformerMapping'][0] ]) : PromiseInterface
Get transformer mapping
Parameters
- $id : string
-
ID of transform mapping (required)
- $contentType : string = self::contentTypes['getTransformerMapping'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformerMapping'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTransformerMappingRequest()
Create request for operation 'getTransformerMapping'
public
getTransformerMappingRequest(string $id[, string $contentType = self::contentTypes['getTransformerMapping'][0] ]) : Request
Parameters
- $id : string
-
ID of transform mapping (required)
- $contentType : string = self::contentTypes['getTransformerMapping'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformerMapping'] to see the possible values for this operation
Tags
Return values
Request —getTransformerMappings()
Operation getTransformerMappings
public
getTransformerMappings([string $ai_transform_id = null ][, string $entity_id = null ][, string $entity_type = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getTransformerMappings'][0] ]) : PageAITransformMappingProjection
Get transformer mappings
Parameters
- $ai_transform_id : string = null
-
ai_transform_id (optional)
- $entity_id : string = null
-
entity_id (optional)
- $entity_type : string = null
-
entity_type (optional)
- $page : int
-
page (optional, default to 0)
- $size : int = 20
-
Optional page size. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getTransformerMappings'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformerMappings'] to see the possible values for this operation
Tags
Return values
PageAITransformMappingProjection —getTransformerMappingsAsync()
Operation getTransformerMappingsAsync
public
getTransformerMappingsAsync([string $ai_transform_id = null ][, string $entity_id = null ][, string $entity_type = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getTransformerMappings'][0] ]) : PromiseInterface
Get transformer mappings
Parameters
- $ai_transform_id : string = null
-
(optional)
- $entity_id : string = null
-
(optional)
- $entity_type : string = null
-
(optional)
- $page : int
-
(optional, default to 0)
- $size : int = 20
-
Optional page size. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getTransformerMappings'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformerMappings'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTransformerMappingsAsyncWithHttpInfo()
Operation getTransformerMappingsAsyncWithHttpInfo
public
getTransformerMappingsAsyncWithHttpInfo([string $ai_transform_id = null ][, string $entity_id = null ][, string $entity_type = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getTransformerMappings'][0] ]) : PromiseInterface
Get transformer mappings
Parameters
- $ai_transform_id : string = null
-
(optional)
- $entity_id : string = null
-
(optional)
- $entity_type : string = null
-
(optional)
- $page : int
-
(optional, default to 0)
- $size : int = 20
-
Optional page size. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getTransformerMappings'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformerMappings'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTransformerMappingsRequest()
Create request for operation 'getTransformerMappings'
public
getTransformerMappingsRequest([string $ai_transform_id = null ][, string $entity_id = null ][, string $entity_type = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getTransformerMappings'][0] ]) : Request
Parameters
- $ai_transform_id : string = null
-
(optional)
- $entity_id : string = null
-
(optional)
- $entity_type : string = null
-
(optional)
- $page : int
-
(optional, default to 0)
- $size : int = 20
-
Optional page size. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getTransformerMappings'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformerMappings'] to see the possible values for this operation
Tags
Return values
Request —getTransformerMappingsWithHttpInfo()
Operation getTransformerMappingsWithHttpInfo
public
getTransformerMappingsWithHttpInfo([string $ai_transform_id = null ][, string $entity_id = null ][, string $entity_type = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getTransformerMappings'][0] ]) : array<string|int, mixed>
Get transformer mappings
Parameters
- $ai_transform_id : string = null
-
(optional)
- $entity_id : string = null
-
(optional)
- $entity_type : string = null
-
(optional)
- $page : int
-
(optional, default to 0)
- $size : int = 20
-
Optional page size. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getTransformerMappings'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformerMappings'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageAITransformMappingProjection, HTTP status code, HTTP response headers (array of strings)
getTransformerMappingWithHttpInfo()
Operation getTransformerMappingWithHttpInfo
public
getTransformerMappingWithHttpInfo(string $id[, string $contentType = self::contentTypes['getTransformerMapping'][0] ]) : array<string|int, mixed>
Get transformer mapping
Parameters
- $id : string
-
ID of transform mapping (required)
- $contentType : string = self::contentTypes['getTransformerMapping'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformerMapping'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\AITransformMappingDto, HTTP status code, HTTP response headers (array of strings)
getTransformerRequest()
Create request for operation 'getTransformer'
public
getTransformerRequest(string $id[, string $contentType = self::contentTypes['getTransformer'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getTransformer'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformer'] to see the possible values for this operation
Tags
Return values
Request —getTransformerResult()
Operation getTransformerResult
public
getTransformerResult(string $id[, string $contentType = self::contentTypes['getTransformerResult'][0] ]) : AITransformResultDto
Get transformer result
Parameters
- $id : string
-
ID of transform result (required)
- $contentType : string = self::contentTypes['getTransformerResult'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformerResult'] to see the possible values for this operation
Tags
Return values
AITransformResultDto —getTransformerResultAsync()
Operation getTransformerResultAsync
public
getTransformerResultAsync(string $id[, string $contentType = self::contentTypes['getTransformerResult'][0] ]) : PromiseInterface
Get transformer result
Parameters
- $id : string
-
ID of transform result (required)
- $contentType : string = self::contentTypes['getTransformerResult'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformerResult'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTransformerResultAsyncWithHttpInfo()
Operation getTransformerResultAsyncWithHttpInfo
public
getTransformerResultAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getTransformerResult'][0] ]) : PromiseInterface
Get transformer result
Parameters
- $id : string
-
ID of transform result (required)
- $contentType : string = self::contentTypes['getTransformerResult'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformerResult'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTransformerResultRequest()
Create request for operation 'getTransformerResult'
public
getTransformerResultRequest(string $id[, string $contentType = self::contentTypes['getTransformerResult'][0] ]) : Request
Parameters
- $id : string
-
ID of transform result (required)
- $contentType : string = self::contentTypes['getTransformerResult'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformerResult'] to see the possible values for this operation
Tags
Return values
Request —getTransformerResults()
Operation getTransformerResults
public
getTransformerResults([string $ai_transform_id = null ][, string $ai_transform_mapping_id = null ][, string $entity_id = null ][, string $entity_type = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getTransformerResults'][0] ]) : PageAITransformResultProjection
Get transformer results
Parameters
- $ai_transform_id : string = null
-
ai_transform_id (optional)
- $ai_transform_mapping_id : string = null
-
ai_transform_mapping_id (optional)
- $entity_id : string = null
-
entity_id (optional)
- $entity_type : string = null
-
entity_type (optional)
- $page : int
-
page (optional, default to 0)
- $size : int = 20
-
Optional page size. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getTransformerResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformerResults'] to see the possible values for this operation
Tags
Return values
PageAITransformResultProjection —getTransformerResultsAsync()
Operation getTransformerResultsAsync
public
getTransformerResultsAsync([string $ai_transform_id = null ][, string $ai_transform_mapping_id = null ][, string $entity_id = null ][, string $entity_type = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getTransformerResults'][0] ]) : PromiseInterface
Get transformer results
Parameters
- $ai_transform_id : string = null
-
(optional)
- $ai_transform_mapping_id : string = null
-
(optional)
- $entity_id : string = null
-
(optional)
- $entity_type : string = null
-
(optional)
- $page : int
-
(optional, default to 0)
- $size : int = 20
-
Optional page size. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getTransformerResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformerResults'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTransformerResultsAsyncWithHttpInfo()
Operation getTransformerResultsAsyncWithHttpInfo
public
getTransformerResultsAsyncWithHttpInfo([string $ai_transform_id = null ][, string $ai_transform_mapping_id = null ][, string $entity_id = null ][, string $entity_type = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getTransformerResults'][0] ]) : PromiseInterface
Get transformer results
Parameters
- $ai_transform_id : string = null
-
(optional)
- $ai_transform_mapping_id : string = null
-
(optional)
- $entity_id : string = null
-
(optional)
- $entity_type : string = null
-
(optional)
- $page : int
-
(optional, default to 0)
- $size : int = 20
-
Optional page size. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getTransformerResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformerResults'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTransformerResultsRequest()
Create request for operation 'getTransformerResults'
public
getTransformerResultsRequest([string $ai_transform_id = null ][, string $ai_transform_mapping_id = null ][, string $entity_id = null ][, string $entity_type = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getTransformerResults'][0] ]) : Request
Parameters
- $ai_transform_id : string = null
-
(optional)
- $ai_transform_mapping_id : string = null
-
(optional)
- $entity_id : string = null
-
(optional)
- $entity_type : string = null
-
(optional)
- $page : int
-
(optional, default to 0)
- $size : int = 20
-
Optional page size. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getTransformerResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformerResults'] to see the possible values for this operation
Tags
Return values
Request —getTransformerResultsWithHttpInfo()
Operation getTransformerResultsWithHttpInfo
public
getTransformerResultsWithHttpInfo([string $ai_transform_id = null ][, string $ai_transform_mapping_id = null ][, string $entity_id = null ][, string $entity_type = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getTransformerResults'][0] ]) : array<string|int, mixed>
Get transformer results
Parameters
- $ai_transform_id : string = null
-
(optional)
- $ai_transform_mapping_id : string = null
-
(optional)
- $entity_id : string = null
-
(optional)
- $entity_type : string = null
-
(optional)
- $page : int
-
(optional, default to 0)
- $size : int = 20
-
Optional page size. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getTransformerResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformerResults'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageAITransformResultProjection, HTTP status code, HTTP response headers (array of strings)
getTransformerResultWithHttpInfo()
Operation getTransformerResultWithHttpInfo
public
getTransformerResultWithHttpInfo(string $id[, string $contentType = self::contentTypes['getTransformerResult'][0] ]) : array<string|int, mixed>
Get transformer result
Parameters
- $id : string
-
ID of transform result (required)
- $contentType : string = self::contentTypes['getTransformerResult'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformerResult'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\AITransformResultDto, HTTP status code, HTTP response headers (array of strings)
getTransformers()
Operation getTransformers
public
getTransformers(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, array<string|int, string> $include = null ][, string $contentType = self::contentTypes['getTransformers'][0] ]) : PageAITransformProjection
List transformers
Parameters
- $page : int
-
page (optional, default to 0)
- $size : int = 20
-
Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $include : array<string|int, string> = null
-
Optional list of IDs to include in result (optional)
- $contentType : string = self::contentTypes['getTransformers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformers'] to see the possible values for this operation
Tags
Return values
PageAITransformProjection —getTransformersAsync()
Operation getTransformersAsync
public
getTransformersAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, array<string|int, string> $include = null ][, string $contentType = self::contentTypes['getTransformers'][0] ]) : PromiseInterface
List transformers
Parameters
- $page : int
-
(optional, default to 0)
- $size : int = 20
-
Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $include : array<string|int, string> = null
-
Optional list of IDs to include in result (optional)
- $contentType : string = self::contentTypes['getTransformers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformers'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTransformersAsyncWithHttpInfo()
Operation getTransformersAsyncWithHttpInfo
public
getTransformersAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, array<string|int, string> $include = null ][, string $contentType = self::contentTypes['getTransformers'][0] ]) : PromiseInterface
List transformers
Parameters
- $page : int
-
(optional, default to 0)
- $size : int = 20
-
Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $include : array<string|int, string> = null
-
Optional list of IDs to include in result (optional)
- $contentType : string = self::contentTypes['getTransformers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformers'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getTransformersRequest()
Create request for operation 'getTransformers'
public
getTransformersRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, array<string|int, string> $include = null ][, string $contentType = self::contentTypes['getTransformers'][0] ]) : Request
Parameters
- $page : int
-
(optional, default to 0)
- $size : int = 20
-
Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $include : array<string|int, string> = null
-
Optional list of IDs to include in result (optional)
- $contentType : string = self::contentTypes['getTransformers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformers'] to see the possible values for this operation
Tags
Return values
Request —getTransformersWithHttpInfo()
Operation getTransformersWithHttpInfo
public
getTransformersWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, array<string|int, string> $include = null ][, string $contentType = self::contentTypes['getTransformers'][0] ]) : array<string|int, mixed>
List transformers
Parameters
- $page : int
-
(optional, default to 0)
- $size : int = 20
-
Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $include : array<string|int, string> = null
-
Optional list of IDs to include in result (optional)
- $contentType : string = self::contentTypes['getTransformers'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformers'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageAITransformProjection, HTTP status code, HTTP response headers (array of strings)
getTransformerWithHttpInfo()
Operation getTransformerWithHttpInfo
public
getTransformerWithHttpInfo(string $id[, string $contentType = self::contentTypes['getTransformer'][0] ]) : array<string|int, mixed>
Get a transformer
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getTransformer'][0]
-
The value for the Content-Type header. Check self::contentTypes['getTransformer'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\AITransformDto, HTTP status code, HTTP response headers (array of strings)
invokeTransformer()
Operation invokeTransformer
public
invokeTransformer(InvokeTransformerOptions $invoke_transformer_options[, string $contentType = self::contentTypes['invokeTransformer'][0] ]) : ConditionalStructuredContentResult
Invoke a transformer
Parameters
- $invoke_transformer_options : InvokeTransformerOptions
-
invoke_transformer_options (required)
- $contentType : string = self::contentTypes['invokeTransformer'][0]
-
The value for the Content-Type header. Check self::contentTypes['invokeTransformer'] to see the possible values for this operation
Tags
Return values
ConditionalStructuredContentResult —invokeTransformerAsync()
Operation invokeTransformerAsync
public
invokeTransformerAsync(InvokeTransformerOptions $invoke_transformer_options[, string $contentType = self::contentTypes['invokeTransformer'][0] ]) : PromiseInterface
Invoke a transformer
Parameters
- $invoke_transformer_options : InvokeTransformerOptions
-
(required)
- $contentType : string = self::contentTypes['invokeTransformer'][0]
-
The value for the Content-Type header. Check self::contentTypes['invokeTransformer'] to see the possible values for this operation
Tags
Return values
PromiseInterface —invokeTransformerAsyncWithHttpInfo()
Operation invokeTransformerAsyncWithHttpInfo
public
invokeTransformerAsyncWithHttpInfo(InvokeTransformerOptions $invoke_transformer_options[, string $contentType = self::contentTypes['invokeTransformer'][0] ]) : PromiseInterface
Invoke a transformer
Parameters
- $invoke_transformer_options : InvokeTransformerOptions
-
(required)
- $contentType : string = self::contentTypes['invokeTransformer'][0]
-
The value for the Content-Type header. Check self::contentTypes['invokeTransformer'] to see the possible values for this operation
Tags
Return values
PromiseInterface —invokeTransformerRequest()
Create request for operation 'invokeTransformer'
public
invokeTransformerRequest(InvokeTransformerOptions $invoke_transformer_options[, string $contentType = self::contentTypes['invokeTransformer'][0] ]) : Request
Parameters
- $invoke_transformer_options : InvokeTransformerOptions
-
(required)
- $contentType : string = self::contentTypes['invokeTransformer'][0]
-
The value for the Content-Type header. Check self::contentTypes['invokeTransformer'] to see the possible values for this operation
Tags
Return values
Request —invokeTransformerWithHttpInfo()
Operation invokeTransformerWithHttpInfo
public
invokeTransformerWithHttpInfo(InvokeTransformerOptions $invoke_transformer_options[, string $contentType = self::contentTypes['invokeTransformer'][0] ]) : array<string|int, mixed>
Invoke a transformer
Parameters
- $invoke_transformer_options : InvokeTransformerOptions
-
(required)
- $contentType : string = self::contentTypes['invokeTransformer'][0]
-
The value for the Content-Type header. Check self::contentTypes['invokeTransformer'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\ConditionalStructuredContentResult, 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 —validateStructuredOutputSchema()
Operation validateStructuredOutputSchema
public
validateStructuredOutputSchema(StructuredOutputSchema $structured_output_schema[, string $contentType = self::contentTypes['validateStructuredOutputSchema'][0] ]) : StructuredOutputSchemaValidation
Validate structured content schema
Parameters
- $structured_output_schema : StructuredOutputSchema
-
structured_output_schema (required)
- $contentType : string = self::contentTypes['validateStructuredOutputSchema'][0]
-
The value for the Content-Type header. Check self::contentTypes['validateStructuredOutputSchema'] to see the possible values for this operation
Tags
Return values
StructuredOutputSchemaValidation —validateStructuredOutputSchemaAsync()
Operation validateStructuredOutputSchemaAsync
public
validateStructuredOutputSchemaAsync(StructuredOutputSchema $structured_output_schema[, string $contentType = self::contentTypes['validateStructuredOutputSchema'][0] ]) : PromiseInterface
Validate structured content schema
Parameters
- $structured_output_schema : StructuredOutputSchema
-
(required)
- $contentType : string = self::contentTypes['validateStructuredOutputSchema'][0]
-
The value for the Content-Type header. Check self::contentTypes['validateStructuredOutputSchema'] to see the possible values for this operation
Tags
Return values
PromiseInterface —validateStructuredOutputSchemaAsyncWithHttpInfo()
Operation validateStructuredOutputSchemaAsyncWithHttpInfo
public
validateStructuredOutputSchemaAsyncWithHttpInfo(StructuredOutputSchema $structured_output_schema[, string $contentType = self::contentTypes['validateStructuredOutputSchema'][0] ]) : PromiseInterface
Validate structured content schema
Parameters
- $structured_output_schema : StructuredOutputSchema
-
(required)
- $contentType : string = self::contentTypes['validateStructuredOutputSchema'][0]
-
The value for the Content-Type header. Check self::contentTypes['validateStructuredOutputSchema'] to see the possible values for this operation
Tags
Return values
PromiseInterface —validateStructuredOutputSchemaRequest()
Create request for operation 'validateStructuredOutputSchema'
public
validateStructuredOutputSchemaRequest(StructuredOutputSchema $structured_output_schema[, string $contentType = self::contentTypes['validateStructuredOutputSchema'][0] ]) : Request
Parameters
- $structured_output_schema : StructuredOutputSchema
-
(required)
- $contentType : string = self::contentTypes['validateStructuredOutputSchema'][0]
-
The value for the Content-Type header. Check self::contentTypes['validateStructuredOutputSchema'] to see the possible values for this operation
Tags
Return values
Request —validateStructuredOutputSchemaWithHttpInfo()
Operation validateStructuredOutputSchemaWithHttpInfo
public
validateStructuredOutputSchemaWithHttpInfo(StructuredOutputSchema $structured_output_schema[, string $contentType = self::contentTypes['validateStructuredOutputSchema'][0] ]) : array<string|int, mixed>
Validate structured content schema
Parameters
- $structured_output_schema : StructuredOutputSchema
-
(required)
- $contentType : string = self::contentTypes['validateStructuredOutputSchema'][0]
-
The value for the Content-Type header. Check self::contentTypes['validateStructuredOutputSchema'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\StructuredOutputSchemaValidation, 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