Documentation

AIControllerApi
in package

AIControllerApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

contentTypes  = ['assertAIMessage' => ['application/json'], 'createTransformer' => ['application/json'], 'createTransformerMappings' => ['application/json'], 'deleteAllTransformerMappings' => ['application/json'], 'deleteTransformer' => ['application/json'], 'deleteTransformerMapping' => ['application/json'], 'deleteTransformerResult' => ['application/json'], 'deleteTransformerResults' => ['application/json'], 'deleteTransformers' => ['application/json'], 'exportTransformerResults' => ['application/json'], 'extractAIMessage' => ['application/json'], 'generateStructuredContentFromAttachment' => ['application/json'], 'generateStructuredContentFromEmail' => ['application/json'], 'generateStructuredContentFromSms' => ['application/json'], 'getAIMessageModels' => ['application/json'], 'getExportTransformerResultsJob' => ['application/json'], 'getTransformer' => ['application/json'], 'getTransformerMapping' => ['application/json'], 'getTransformerMappings' => ['application/json'], 'getTransformerResult' => ['application/json'], 'getTransformerResults' => ['application/json'], 'getTransformerResultsTable' => ['application/json'], 'getTransformers' => ['application/json'], 'invokeTransformer' => ['application/json'], 'testTransformerMappingMatch' => ['application/json'], 'validateStructuredOutputSchema' => ['application/json'], 'waitForAIMessage' => ['application/json'], 'waitForAIMessages' => ['application/json']]
$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
$hostIndex  : int
__construct()  : mixed
assertAIMessage()  : AIMessageResult
Operation assertAIMessage
assertAIMessageAsync()  : PromiseInterface
Operation assertAIMessageAsync
assertAIMessageAsyncWithHttpInfo()  : PromiseInterface
Operation assertAIMessageAsyncWithHttpInfo
assertAIMessageRequest()  : Request
Create request for operation 'assertAIMessage'
assertAIMessageWithHttpInfo()  : array<string|int, mixed>
Operation assertAIMessageWithHttpInfo
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'
deleteTransformerResult()  : void
Operation deleteTransformerResult
deleteTransformerResultAsync()  : PromiseInterface
Operation deleteTransformerResultAsync
deleteTransformerResultAsyncWithHttpInfo()  : PromiseInterface
Operation deleteTransformerResultAsyncWithHttpInfo
deleteTransformerResultRequest()  : Request
Create request for operation 'deleteTransformerResult'
deleteTransformerResults()  : void
Operation deleteTransformerResults
deleteTransformerResultsAsync()  : PromiseInterface
Operation deleteTransformerResultsAsync
deleteTransformerResultsAsyncWithHttpInfo()  : PromiseInterface
Operation deleteTransformerResultsAsyncWithHttpInfo
deleteTransformerResultsRequest()  : Request
Create request for operation 'deleteTransformerResults'
deleteTransformerResultsWithHttpInfo()  : array<string|int, mixed>
Operation deleteTransformerResultsWithHttpInfo
deleteTransformerResultWithHttpInfo()  : array<string|int, mixed>
Operation deleteTransformerResultWithHttpInfo
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
exportTransformerResults()  : ExportTransformerResponse
Operation exportTransformerResults
exportTransformerResultsAsync()  : PromiseInterface
Operation exportTransformerResultsAsync
exportTransformerResultsAsyncWithHttpInfo()  : PromiseInterface
Operation exportTransformerResultsAsyncWithHttpInfo
exportTransformerResultsRequest()  : Request
Create request for operation 'exportTransformerResults'
exportTransformerResultsWithHttpInfo()  : array<string|int, mixed>
Operation exportTransformerResultsWithHttpInfo
extractAIMessage()  : AIMessageResult
Operation extractAIMessage
extractAIMessageAsync()  : PromiseInterface
Operation extractAIMessageAsync
extractAIMessageAsyncWithHttpInfo()  : PromiseInterface
Operation extractAIMessageAsyncWithHttpInfo
extractAIMessageRequest()  : Request
Create request for operation 'extractAIMessage'
extractAIMessageWithHttpInfo()  : array<string|int, mixed>
Operation extractAIMessageWithHttpInfo
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
getAIMessageModels()  : array<string|int, AIMessageModelDto>
Operation getAIMessageModels
getAIMessageModelsAsync()  : PromiseInterface
Operation getAIMessageModelsAsync
getAIMessageModelsAsyncWithHttpInfo()  : PromiseInterface
Operation getAIMessageModelsAsyncWithHttpInfo
getAIMessageModelsRequest()  : Request
Create request for operation 'getAIMessageModels'
getAIMessageModelsWithHttpInfo()  : array<string|int, mixed>
Operation getAIMessageModelsWithHttpInfo
getConfig()  : Configuration
getExportTransformerResultsJob()  : ExportTransformerResultJobDto
Operation getExportTransformerResultsJob
getExportTransformerResultsJobAsync()  : PromiseInterface
Operation getExportTransformerResultsJobAsync
getExportTransformerResultsJobAsyncWithHttpInfo()  : PromiseInterface
Operation getExportTransformerResultsJobAsyncWithHttpInfo
getExportTransformerResultsJobRequest()  : Request
Create request for operation 'getExportTransformerResultsJob'
getExportTransformerResultsJobWithHttpInfo()  : array<string|int, mixed>
Operation getExportTransformerResultsJobWithHttpInfo
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'
getTransformerResultsTable()  : PageTableData
Operation getTransformerResultsTable
getTransformerResultsTableAsync()  : PromiseInterface
Operation getTransformerResultsTableAsync
getTransformerResultsTableAsyncWithHttpInfo()  : PromiseInterface
Operation getTransformerResultsTableAsyncWithHttpInfo
getTransformerResultsTableRequest()  : Request
Create request for operation 'getTransformerResultsTable'
getTransformerResultsTableWithHttpInfo()  : array<string|int, mixed>
Operation getTransformerResultsTableWithHttpInfo
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
testTransformerMappingMatch()  : AITransformMappingMatchResult
Operation testTransformerMappingMatch
testTransformerMappingMatchAsync()  : PromiseInterface
Operation testTransformerMappingMatchAsync
testTransformerMappingMatchAsyncWithHttpInfo()  : PromiseInterface
Operation testTransformerMappingMatchAsyncWithHttpInfo
testTransformerMappingMatchRequest()  : Request
Create request for operation 'testTransformerMappingMatch'
testTransformerMappingMatchWithHttpInfo()  : array<string|int, mixed>
Operation testTransformerMappingMatchWithHttpInfo
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
waitForAIMessage()  : AIMessageResult
Operation waitForAIMessage
waitForAIMessageAsync()  : PromiseInterface
Operation waitForAIMessageAsync
waitForAIMessageAsyncWithHttpInfo()  : PromiseInterface
Operation waitForAIMessageAsyncWithHttpInfo
waitForAIMessageRequest()  : Request
Create request for operation 'waitForAIMessage'
waitForAIMessages()  : AIMessagesResult
Operation waitForAIMessages
waitForAIMessagesAsync()  : PromiseInterface
Operation waitForAIMessagesAsync
waitForAIMessagesAsyncWithHttpInfo()  : PromiseInterface
Operation waitForAIMessagesAsyncWithHttpInfo
waitForAIMessagesRequest()  : Request
Create request for operation 'waitForAIMessages'
waitForAIMessagesWithHttpInfo()  : array<string|int, mixed>
Operation waitForAIMessagesWithHttpInfo
waitForAIMessageWithHttpInfo()  : array<string|int, mixed>
Operation waitForAIMessageWithHttpInfo
createHttpClientOption()  : array<string|int, mixed>
Create http client option

Constants

contentTypes

public array<string|int, string> contentTypes = ['assertAIMessage' => ['application/json'], 'createTransformer' => ['application/json'], 'createTransformerMappings' => ['application/json'], 'deleteAllTransformerMappings' => ['application/json'], 'deleteTransformer' => ['application/json'], 'deleteTransformerMapping' => ['application/json'], 'deleteTransformerResult' => ['application/json'], 'deleteTransformerResults' => ['application/json'], 'deleteTransformers' => ['application/json'], 'exportTransformerResults' => ['application/json'], 'extractAIMessage' => ['application/json'], 'generateStructuredContentFromAttachment' => ['application/json'], 'generateStructuredContentFromEmail' => ['application/json'], 'generateStructuredContentFromSms' => ['application/json'], 'getAIMessageModels' => ['application/json'], 'getExportTransformerResultsJob' => ['application/json'], 'getTransformer' => ['application/json'], 'getTransformerMapping' => ['application/json'], 'getTransformerMappings' => ['application/json'], 'getTransformerResult' => ['application/json'], 'getTransformerResults' => ['application/json'], 'getTransformerResultsTable' => ['application/json'], 'getTransformers' => ['application/json'], 'invokeTransformer' => ['application/json'], 'testTransformerMappingMatch' => ['application/json'], 'validateStructuredOutputSchema' => ['application/json'], 'waitForAIMessage' => ['application/json'], 'waitForAIMessages' => ['application/json']]

Properties

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 —

assertAIMessage()

Operation assertAIMessage

public assertAIMessage(AssertAIMessageOptions $assert_ai_message_options[, string $idempotency_key = null ][, string $contentType = self::contentTypes['assertAIMessage'][0] ]) : AIMessageResult

Check named natural-language assertions against an existing email or SMS

Parameters
$assert_ai_message_options : AssertAIMessageOptions

assert_ai_message_options (required)

$idempotency_key : string = null

idempotency_key (optional)

$contentType : string = self::contentTypes['assertAIMessage'][0]

The value for the Content-Type header. Check self::contentTypes['assertAIMessage'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
AIMessageResult —

assertAIMessageAsync()

Operation assertAIMessageAsync

public assertAIMessageAsync(AssertAIMessageOptions $assert_ai_message_options[, string $idempotency_key = null ][, string $contentType = self::contentTypes['assertAIMessage'][0] ]) : PromiseInterface

Check named natural-language assertions against an existing email or SMS

Parameters
$assert_ai_message_options : AssertAIMessageOptions

(required)

$idempotency_key : string = null

(optional)

$contentType : string = self::contentTypes['assertAIMessage'][0]

The value for the Content-Type header. Check self::contentTypes['assertAIMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

assertAIMessageAsyncWithHttpInfo()

Operation assertAIMessageAsyncWithHttpInfo

public assertAIMessageAsyncWithHttpInfo(AssertAIMessageOptions $assert_ai_message_options[, string $idempotency_key = null ][, string $contentType = self::contentTypes['assertAIMessage'][0] ]) : PromiseInterface

Check named natural-language assertions against an existing email or SMS

Parameters
$assert_ai_message_options : AssertAIMessageOptions

(required)

$idempotency_key : string = null

(optional)

$contentType : string = self::contentTypes['assertAIMessage'][0]

The value for the Content-Type header. Check self::contentTypes['assertAIMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

assertAIMessageRequest()

Create request for operation 'assertAIMessage'

public assertAIMessageRequest(AssertAIMessageOptions $assert_ai_message_options[, string $idempotency_key = null ][, string $contentType = self::contentTypes['assertAIMessage'][0] ]) : Request
Parameters
$assert_ai_message_options : AssertAIMessageOptions

(required)

$idempotency_key : string = null

(optional)

$contentType : string = self::contentTypes['assertAIMessage'][0]

The value for the Content-Type header. Check self::contentTypes['assertAIMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

assertAIMessageWithHttpInfo()

Operation assertAIMessageWithHttpInfo

public assertAIMessageWithHttpInfo(AssertAIMessageOptions $assert_ai_message_options[, string $idempotency_key = null ][, string $contentType = self::contentTypes['assertAIMessage'][0] ]) : array<string|int, mixed>

Check named natural-language assertions against an existing email or SMS

Parameters
$assert_ai_message_options : AssertAIMessageOptions

(required)

$idempotency_key : string = null

(optional)

$contentType : string = self::contentTypes['assertAIMessage'][0]

The value for the Content-Type header. Check self::contentTypes['assertAIMessage'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\AIMessageResult, HTTP status code, HTTP response headers (array of strings)

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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
Return values
Request —

deleteTransformerResult()

Operation deleteTransformerResult

public deleteTransformerResult(string $id[, string $contentType = self::contentTypes['deleteTransformerResult'][0] ]) : void

Delete a transformer result

Parameters
$id : string

id (required)

$contentType : string = self::contentTypes['deleteTransformerResult'][0]

The value for the Content-Type header. Check self::contentTypes['deleteTransformerResult'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void —

deleteTransformerResultAsync()

Operation deleteTransformerResultAsync

public deleteTransformerResultAsync(string $id[, string $contentType = self::contentTypes['deleteTransformerResult'][0] ]) : PromiseInterface

Delete a transformer result

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['deleteTransformerResult'][0]

The value for the Content-Type header. Check self::contentTypes['deleteTransformerResult'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

deleteTransformerResultAsyncWithHttpInfo()

Operation deleteTransformerResultAsyncWithHttpInfo

public deleteTransformerResultAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteTransformerResult'][0] ]) : PromiseInterface

Delete a transformer result

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['deleteTransformerResult'][0]

The value for the Content-Type header. Check self::contentTypes['deleteTransformerResult'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

deleteTransformerResultRequest()

Create request for operation 'deleteTransformerResult'

public deleteTransformerResultRequest(string $id[, string $contentType = self::contentTypes['deleteTransformerResult'][0] ]) : Request
Parameters
$id : string

(required)

$contentType : string = self::contentTypes['deleteTransformerResult'][0]

The value for the Content-Type header. Check self::contentTypes['deleteTransformerResult'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

deleteTransformerResults()

Operation deleteTransformerResults

public deleteTransformerResults([string $ai_transform_id = null ][, string $contentType = self::contentTypes['deleteTransformerResults'][0] ]) : void

Delete transformer results

Parameters
$ai_transform_id : string = null

ai_transform_id (optional)

$contentType : string = self::contentTypes['deleteTransformerResults'][0]

The value for the Content-Type header. Check self::contentTypes['deleteTransformerResults'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void —

deleteTransformerResultsAsync()

Operation deleteTransformerResultsAsync

public deleteTransformerResultsAsync([string $ai_transform_id = null ][, string $contentType = self::contentTypes['deleteTransformerResults'][0] ]) : PromiseInterface

Delete transformer results

Parameters
$ai_transform_id : string = null

(optional)

$contentType : string = self::contentTypes['deleteTransformerResults'][0]

The value for the Content-Type header. Check self::contentTypes['deleteTransformerResults'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

deleteTransformerResultsAsyncWithHttpInfo()

Operation deleteTransformerResultsAsyncWithHttpInfo

public deleteTransformerResultsAsyncWithHttpInfo([string $ai_transform_id = null ][, string $contentType = self::contentTypes['deleteTransformerResults'][0] ]) : PromiseInterface

Delete transformer results

Parameters
$ai_transform_id : string = null

(optional)

$contentType : string = self::contentTypes['deleteTransformerResults'][0]

The value for the Content-Type header. Check self::contentTypes['deleteTransformerResults'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

deleteTransformerResultsRequest()

Create request for operation 'deleteTransformerResults'

public deleteTransformerResultsRequest([string $ai_transform_id = null ][, string $contentType = self::contentTypes['deleteTransformerResults'][0] ]) : Request
Parameters
$ai_transform_id : string = null

(optional)

$contentType : string = self::contentTypes['deleteTransformerResults'][0]

The value for the Content-Type header. Check self::contentTypes['deleteTransformerResults'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

deleteTransformerResultsWithHttpInfo()

Operation deleteTransformerResultsWithHttpInfo

public deleteTransformerResultsWithHttpInfo([string $ai_transform_id = null ][, string $contentType = self::contentTypes['deleteTransformerResults'][0] ]) : array<string|int, mixed>

Delete transformer results

Parameters
$ai_transform_id : string = null

(optional)

$contentType : string = self::contentTypes['deleteTransformerResults'][0]

The value for the Content-Type header. Check self::contentTypes['deleteTransformerResults'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

deleteTransformerResultWithHttpInfo()

Operation deleteTransformerResultWithHttpInfo

public deleteTransformerResultWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteTransformerResult'][0] ]) : array<string|int, mixed>

Delete a transformer result

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['deleteTransformerResult'][0]

The value for the Content-Type header. Check self::contentTypes['deleteTransformerResult'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

exportTransformerResults()

Operation exportTransformerResults

public exportTransformerResults(ExportTransformerOptions $export_transformer_options[, string $contentType = self::contentTypes['exportTransformerResults'][0] ]) : ExportTransformerResponse

Export transformer results

Parameters
$export_transformer_options : ExportTransformerOptions

export_transformer_options (required)

$contentType : string = self::contentTypes['exportTransformerResults'][0]

The value for the Content-Type header. Check self::contentTypes['exportTransformerResults'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
ExportTransformerResponse —

exportTransformerResultsAsync()

Operation exportTransformerResultsAsync

public exportTransformerResultsAsync(ExportTransformerOptions $export_transformer_options[, string $contentType = self::contentTypes['exportTransformerResults'][0] ]) : PromiseInterface

Export transformer results

Parameters
$export_transformer_options : ExportTransformerOptions

(required)

$contentType : string = self::contentTypes['exportTransformerResults'][0]

The value for the Content-Type header. Check self::contentTypes['exportTransformerResults'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

exportTransformerResultsAsyncWithHttpInfo()

Operation exportTransformerResultsAsyncWithHttpInfo

public exportTransformerResultsAsyncWithHttpInfo(ExportTransformerOptions $export_transformer_options[, string $contentType = self::contentTypes['exportTransformerResults'][0] ]) : PromiseInterface

Export transformer results

Parameters
$export_transformer_options : ExportTransformerOptions

(required)

$contentType : string = self::contentTypes['exportTransformerResults'][0]

The value for the Content-Type header. Check self::contentTypes['exportTransformerResults'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

exportTransformerResultsRequest()

Create request for operation 'exportTransformerResults'

public exportTransformerResultsRequest(ExportTransformerOptions $export_transformer_options[, string $contentType = self::contentTypes['exportTransformerResults'][0] ]) : Request
Parameters
$export_transformer_options : ExportTransformerOptions

(required)

$contentType : string = self::contentTypes['exportTransformerResults'][0]

The value for the Content-Type header. Check self::contentTypes['exportTransformerResults'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

exportTransformerResultsWithHttpInfo()

Operation exportTransformerResultsWithHttpInfo

public exportTransformerResultsWithHttpInfo(ExportTransformerOptions $export_transformer_options[, string $contentType = self::contentTypes['exportTransformerResults'][0] ]) : array<string|int, mixed>

Export transformer results

Parameters
$export_transformer_options : ExportTransformerOptions

(required)

$contentType : string = self::contentTypes['exportTransformerResults'][0]

The value for the Content-Type header. Check self::contentTypes['exportTransformerResults'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\ExportTransformerResponse, HTTP status code, HTTP response headers (array of strings)

extractAIMessage()

Operation extractAIMessage

public extractAIMessage(ExtractAIMessageOptions $extract_ai_message_options[, string $idempotency_key = null ][, string $contentType = self::contentTypes['extractAIMessage'][0] ]) : AIMessageResult

Extract schema-validated data from an existing email or SMS with verified source evidence

Parameters
$extract_ai_message_options : ExtractAIMessageOptions

extract_ai_message_options (required)

$idempotency_key : string = null

idempotency_key (optional)

$contentType : string = self::contentTypes['extractAIMessage'][0]

The value for the Content-Type header. Check self::contentTypes['extractAIMessage'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
AIMessageResult —

extractAIMessageAsync()

Operation extractAIMessageAsync

public extractAIMessageAsync(ExtractAIMessageOptions $extract_ai_message_options[, string $idempotency_key = null ][, string $contentType = self::contentTypes['extractAIMessage'][0] ]) : PromiseInterface

Extract schema-validated data from an existing email or SMS with verified source evidence

Parameters
$extract_ai_message_options : ExtractAIMessageOptions

(required)

$idempotency_key : string = null

(optional)

$contentType : string = self::contentTypes['extractAIMessage'][0]

The value for the Content-Type header. Check self::contentTypes['extractAIMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

extractAIMessageAsyncWithHttpInfo()

Operation extractAIMessageAsyncWithHttpInfo

public extractAIMessageAsyncWithHttpInfo(ExtractAIMessageOptions $extract_ai_message_options[, string $idempotency_key = null ][, string $contentType = self::contentTypes['extractAIMessage'][0] ]) : PromiseInterface

Extract schema-validated data from an existing email or SMS with verified source evidence

Parameters
$extract_ai_message_options : ExtractAIMessageOptions

(required)

$idempotency_key : string = null

(optional)

$contentType : string = self::contentTypes['extractAIMessage'][0]

The value for the Content-Type header. Check self::contentTypes['extractAIMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

extractAIMessageRequest()

Create request for operation 'extractAIMessage'

public extractAIMessageRequest(ExtractAIMessageOptions $extract_ai_message_options[, string $idempotency_key = null ][, string $contentType = self::contentTypes['extractAIMessage'][0] ]) : Request
Parameters
$extract_ai_message_options : ExtractAIMessageOptions

(required)

$idempotency_key : string = null

(optional)

$contentType : string = self::contentTypes['extractAIMessage'][0]

The value for the Content-Type header. Check self::contentTypes['extractAIMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

extractAIMessageWithHttpInfo()

Operation extractAIMessageWithHttpInfo

public extractAIMessageWithHttpInfo(ExtractAIMessageOptions $extract_ai_message_options[, string $idempotency_key = null ][, string $contentType = self::contentTypes['extractAIMessage'][0] ]) : array<string|int, mixed>

Extract schema-validated data from an existing email or SMS with verified source evidence

Parameters
$extract_ai_message_options : ExtractAIMessageOptions

(required)

$idempotency_key : string = null

(optional)

$contentType : string = self::contentTypes['extractAIMessage'][0]

The value for the Content-Type header. Check self::contentTypes['extractAIMessage'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\AIMessageResult, 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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\StructuredContentResultDto, HTTP status code, HTTP response headers (array of strings)

getAIMessageModels()

Operation getAIMessageModels

public getAIMessageModels([string $contentType = self::contentTypes['getAIMessageModels'][0] ]) : array<string|int, AIMessageModelDto>

List supported message-testing AI models

Parameters
$contentType : string = self::contentTypes['getAIMessageModels'][0]

The value for the Content-Type header. Check self::contentTypes['getAIMessageModels'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, AIMessageModelDto> —

getAIMessageModelsAsync()

Operation getAIMessageModelsAsync

public getAIMessageModelsAsync([string $contentType = self::contentTypes['getAIMessageModels'][0] ]) : PromiseInterface

List supported message-testing AI models

Parameters
$contentType : string = self::contentTypes['getAIMessageModels'][0]

The value for the Content-Type header. Check self::contentTypes['getAIMessageModels'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getAIMessageModelsAsyncWithHttpInfo()

Operation getAIMessageModelsAsyncWithHttpInfo

public getAIMessageModelsAsyncWithHttpInfo([string $contentType = self::contentTypes['getAIMessageModels'][0] ]) : PromiseInterface

List supported message-testing AI models

Parameters
$contentType : string = self::contentTypes['getAIMessageModels'][0]

The value for the Content-Type header. Check self::contentTypes['getAIMessageModels'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getAIMessageModelsRequest()

Create request for operation 'getAIMessageModels'

public getAIMessageModelsRequest([string $contentType = self::contentTypes['getAIMessageModels'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['getAIMessageModels'][0]

The value for the Content-Type header. Check self::contentTypes['getAIMessageModels'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

getAIMessageModelsWithHttpInfo()

Operation getAIMessageModelsWithHttpInfo

public getAIMessageModelsWithHttpInfo([string $contentType = self::contentTypes['getAIMessageModels'][0] ]) : array<string|int, mixed>

List supported message-testing AI models

Parameters
$contentType : string = self::contentTypes['getAIMessageModels'][0]

The value for the Content-Type header. Check self::contentTypes['getAIMessageModels'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\AIMessageModelDto[], HTTP status code, HTTP response headers (array of strings)

getExportTransformerResultsJob()

Operation getExportTransformerResultsJob

public getExportTransformerResultsJob(string $id[, string $contentType = self::contentTypes['getExportTransformerResultsJob'][0] ]) : ExportTransformerResultJobDto

Get export transformer results job

Parameters
$id : string

id (required)

$contentType : string = self::contentTypes['getExportTransformerResultsJob'][0]

The value for the Content-Type header. Check self::contentTypes['getExportTransformerResultsJob'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
ExportTransformerResultJobDto —

getExportTransformerResultsJobAsync()

Operation getExportTransformerResultsJobAsync

public getExportTransformerResultsJobAsync(string $id[, string $contentType = self::contentTypes['getExportTransformerResultsJob'][0] ]) : PromiseInterface

Get export transformer results job

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getExportTransformerResultsJob'][0]

The value for the Content-Type header. Check self::contentTypes['getExportTransformerResultsJob'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getExportTransformerResultsJobAsyncWithHttpInfo()

Operation getExportTransformerResultsJobAsyncWithHttpInfo

public getExportTransformerResultsJobAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getExportTransformerResultsJob'][0] ]) : PromiseInterface

Get export transformer results job

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getExportTransformerResultsJob'][0]

The value for the Content-Type header. Check self::contentTypes['getExportTransformerResultsJob'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getExportTransformerResultsJobRequest()

Create request for operation 'getExportTransformerResultsJob'

public getExportTransformerResultsJobRequest(string $id[, string $contentType = self::contentTypes['getExportTransformerResultsJob'][0] ]) : Request
Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getExportTransformerResultsJob'][0]

The value for the Content-Type header. Check self::contentTypes['getExportTransformerResultsJob'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

getExportTransformerResultsJobWithHttpInfo()

Operation getExportTransformerResultsJobWithHttpInfo

public getExportTransformerResultsJobWithHttpInfo(string $id[, string $contentType = self::contentTypes['getExportTransformerResultsJob'][0] ]) : array<string|int, mixed>

Get export transformer results job

Parameters
$id : string

(required)

$contentType : string = self::contentTypes['getExportTransformerResultsJob'][0]

The value for the Content-Type header. Check self::contentTypes['getExportTransformerResultsJob'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\ExportTransformerResultJobDto, HTTP status code, HTTP response headers (array of strings)

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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
Return values
Request —

getTransformerResults()

Operation getTransformerResults

public getTransformerResults([string $email_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, 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
$email_id : string = null

email_id (optional)

$sms_id : string = null

sms_id (optional)

$attachment_id : string = null

attachment_id (optional)

$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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PageAITransformResultProjection —

getTransformerResultsAsync()

Operation getTransformerResultsAsync

public getTransformerResultsAsync([string $email_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, 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
$email_id : string = null

(optional)

$sms_id : string = null

(optional)

$attachment_id : string = null

(optional)

$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
throws
InvalidArgumentException
Return values
PromiseInterface —

getTransformerResultsAsyncWithHttpInfo()

Operation getTransformerResultsAsyncWithHttpInfo

public getTransformerResultsAsyncWithHttpInfo([string $email_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, 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
$email_id : string = null

(optional)

$sms_id : string = null

(optional)

$attachment_id : string = null

(optional)

$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
throws
InvalidArgumentException
Return values
PromiseInterface —

getTransformerResultsRequest()

Create request for operation 'getTransformerResults'

public getTransformerResultsRequest([string $email_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, 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
$email_id : string = null

(optional)

$sms_id : string = null

(optional)

$attachment_id : string = null

(optional)

$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
throws
InvalidArgumentException
Return values
Request —

getTransformerResultsTable()

Operation getTransformerResultsTable

public getTransformerResultsTable(bool $include_meta_data, bool $flatten_arrays_to_rows[, string $email_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, 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['getTransformerResultsTable'][0] ]) : PageTableData

Get transformer results table

Parameters
$include_meta_data : bool

include_meta_data (required)

$flatten_arrays_to_rows : bool

flatten_arrays_to_rows (required)

$email_id : string = null

email_id (optional)

$sms_id : string = null

sms_id (optional)

$attachment_id : string = null

attachment_id (optional)

$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['getTransformerResultsTable'][0]

The value for the Content-Type header. Check self::contentTypes['getTransformerResultsTable'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PageTableData —

getTransformerResultsTableAsync()

Operation getTransformerResultsTableAsync

public getTransformerResultsTableAsync(bool $include_meta_data, bool $flatten_arrays_to_rows[, string $email_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, 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['getTransformerResultsTable'][0] ]) : PromiseInterface

Get transformer results table

Parameters
$include_meta_data : bool

(required)

$flatten_arrays_to_rows : bool

(required)

$email_id : string = null

(optional)

$sms_id : string = null

(optional)

$attachment_id : string = null

(optional)

$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['getTransformerResultsTable'][0]

The value for the Content-Type header. Check self::contentTypes['getTransformerResultsTable'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getTransformerResultsTableAsyncWithHttpInfo()

Operation getTransformerResultsTableAsyncWithHttpInfo

public getTransformerResultsTableAsyncWithHttpInfo(bool $include_meta_data, bool $flatten_arrays_to_rows[, string $email_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, 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['getTransformerResultsTable'][0] ]) : PromiseInterface

Get transformer results table

Parameters
$include_meta_data : bool

(required)

$flatten_arrays_to_rows : bool

(required)

$email_id : string = null

(optional)

$sms_id : string = null

(optional)

$attachment_id : string = null

(optional)

$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['getTransformerResultsTable'][0]

The value for the Content-Type header. Check self::contentTypes['getTransformerResultsTable'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getTransformerResultsTableRequest()

Create request for operation 'getTransformerResultsTable'

public getTransformerResultsTableRequest(bool $include_meta_data, bool $flatten_arrays_to_rows[, string $email_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, 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['getTransformerResultsTable'][0] ]) : Request
Parameters
$include_meta_data : bool

(required)

$flatten_arrays_to_rows : bool

(required)

$email_id : string = null

(optional)

$sms_id : string = null

(optional)

$attachment_id : string = null

(optional)

$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['getTransformerResultsTable'][0]

The value for the Content-Type header. Check self::contentTypes['getTransformerResultsTable'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

getTransformerResultsTableWithHttpInfo()

Operation getTransformerResultsTableWithHttpInfo

public getTransformerResultsTableWithHttpInfo(bool $include_meta_data, bool $flatten_arrays_to_rows[, string $email_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, 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['getTransformerResultsTable'][0] ]) : array<string|int, mixed>

Get transformer results table

Parameters
$include_meta_data : bool

(required)

$flatten_arrays_to_rows : bool

(required)

$email_id : string = null

(optional)

$sms_id : string = null

(optional)

$attachment_id : string = null

(optional)

$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['getTransformerResultsTable'][0]

The value for the Content-Type header. Check self::contentTypes['getTransformerResultsTable'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\PageTableData, HTTP status code, HTTP response headers (array of strings)

getTransformerResultsWithHttpInfo()

Operation getTransformerResultsWithHttpInfo

public getTransformerResultsWithHttpInfo([string $email_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, 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
$email_id : string = null

(optional)

$sms_id : string = null

(optional)

$attachment_id : string = null

(optional)

$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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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 —

testTransformerMappingMatch()

Operation testTransformerMappingMatch

public testTransformerMappingMatch(string $id[, string $email_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $contentType = self::contentTypes['testTransformerMappingMatch'][0] ]) : AITransformMappingMatchResult

Test transformer mapping match result

Parameters
$id : string

ID of transform mapping (required)

$email_id : string = null

email_id (optional)

$sms_id : string = null

sms_id (optional)

$attachment_id : string = null

attachment_id (optional)

$contentType : string = self::contentTypes['testTransformerMappingMatch'][0]

The value for the Content-Type header. Check self::contentTypes['testTransformerMappingMatch'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
AITransformMappingMatchResult —

testTransformerMappingMatchAsync()

Operation testTransformerMappingMatchAsync

public testTransformerMappingMatchAsync(string $id[, string $email_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $contentType = self::contentTypes['testTransformerMappingMatch'][0] ]) : PromiseInterface

Test transformer mapping match result

Parameters
$id : string

ID of transform mapping (required)

$email_id : string = null

(optional)

$sms_id : string = null

(optional)

$attachment_id : string = null

(optional)

$contentType : string = self::contentTypes['testTransformerMappingMatch'][0]

The value for the Content-Type header. Check self::contentTypes['testTransformerMappingMatch'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

testTransformerMappingMatchAsyncWithHttpInfo()

Operation testTransformerMappingMatchAsyncWithHttpInfo

public testTransformerMappingMatchAsyncWithHttpInfo(string $id[, string $email_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $contentType = self::contentTypes['testTransformerMappingMatch'][0] ]) : PromiseInterface

Test transformer mapping match result

Parameters
$id : string

ID of transform mapping (required)

$email_id : string = null

(optional)

$sms_id : string = null

(optional)

$attachment_id : string = null

(optional)

$contentType : string = self::contentTypes['testTransformerMappingMatch'][0]

The value for the Content-Type header. Check self::contentTypes['testTransformerMappingMatch'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

testTransformerMappingMatchRequest()

Create request for operation 'testTransformerMappingMatch'

public testTransformerMappingMatchRequest(string $id[, string $email_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $contentType = self::contentTypes['testTransformerMappingMatch'][0] ]) : Request
Parameters
$id : string

ID of transform mapping (required)

$email_id : string = null

(optional)

$sms_id : string = null

(optional)

$attachment_id : string = null

(optional)

$contentType : string = self::contentTypes['testTransformerMappingMatch'][0]

The value for the Content-Type header. Check self::contentTypes['testTransformerMappingMatch'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

testTransformerMappingMatchWithHttpInfo()

Operation testTransformerMappingMatchWithHttpInfo

public testTransformerMappingMatchWithHttpInfo(string $id[, string $email_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $contentType = self::contentTypes['testTransformerMappingMatch'][0] ]) : array<string|int, mixed>

Test transformer mapping match result

Parameters
$id : string

ID of transform mapping (required)

$email_id : string = null

(optional)

$sms_id : string = null

(optional)

$attachment_id : string = null

(optional)

$contentType : string = self::contentTypes['testTransformerMappingMatch'][0]

The value for the Content-Type header. Check self::contentTypes['testTransformerMappingMatch'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\AITransformMappingMatchResult, HTTP status code, HTTP response headers (array of strings)

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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\StructuredOutputSchemaValidation, HTTP status code, HTTP response headers (array of strings)

waitForAIMessage()

Operation waitForAIMessage

public waitForAIMessage(WaitForAIMessageOptions $wait_for_ai_message_options[, string $idempotency_key = null ][, string $contentType = self::contentTypes['waitForAIMessage'][0] ]) : AIMessageResult

Find a message across explicit inboxes or phones, then assert and extract from that same message

Parameters
$wait_for_ai_message_options : WaitForAIMessageOptions

wait_for_ai_message_options (required)

$idempotency_key : string = null

idempotency_key (optional)

$contentType : string = self::contentTypes['waitForAIMessage'][0]

The value for the Content-Type header. Check self::contentTypes['waitForAIMessage'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
AIMessageResult —

waitForAIMessageAsync()

Operation waitForAIMessageAsync

public waitForAIMessageAsync(WaitForAIMessageOptions $wait_for_ai_message_options[, string $idempotency_key = null ][, string $contentType = self::contentTypes['waitForAIMessage'][0] ]) : PromiseInterface

Find a message across explicit inboxes or phones, then assert and extract from that same message

Parameters
$wait_for_ai_message_options : WaitForAIMessageOptions

(required)

$idempotency_key : string = null

(optional)

$contentType : string = self::contentTypes['waitForAIMessage'][0]

The value for the Content-Type header. Check self::contentTypes['waitForAIMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

waitForAIMessageAsyncWithHttpInfo()

Operation waitForAIMessageAsyncWithHttpInfo

public waitForAIMessageAsyncWithHttpInfo(WaitForAIMessageOptions $wait_for_ai_message_options[, string $idempotency_key = null ][, string $contentType = self::contentTypes['waitForAIMessage'][0] ]) : PromiseInterface

Find a message across explicit inboxes or phones, then assert and extract from that same message

Parameters
$wait_for_ai_message_options : WaitForAIMessageOptions

(required)

$idempotency_key : string = null

(optional)

$contentType : string = self::contentTypes['waitForAIMessage'][0]

The value for the Content-Type header. Check self::contentTypes['waitForAIMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

waitForAIMessageRequest()

Create request for operation 'waitForAIMessage'

public waitForAIMessageRequest(WaitForAIMessageOptions $wait_for_ai_message_options[, string $idempotency_key = null ][, string $contentType = self::contentTypes['waitForAIMessage'][0] ]) : Request
Parameters
$wait_for_ai_message_options : WaitForAIMessageOptions

(required)

$idempotency_key : string = null

(optional)

$contentType : string = self::contentTypes['waitForAIMessage'][0]

The value for the Content-Type header. Check self::contentTypes['waitForAIMessage'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

waitForAIMessages()

Operation waitForAIMessages

public waitForAIMessages(WaitForAIMessagesOptions $wait_for_ai_messages_options[, string $idempotency_key = null ][, string $contentType = self::contentTypes['waitForAIMessages'][0] ]) : AIMessagesResult

Wait for all named email and SMS expectations under one shared deadline and AI token budget

Parameters
$wait_for_ai_messages_options : WaitForAIMessagesOptions

wait_for_ai_messages_options (required)

$idempotency_key : string = null

idempotency_key (optional)

$contentType : string = self::contentTypes['waitForAIMessages'][0]

The value for the Content-Type header. Check self::contentTypes['waitForAIMessages'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
AIMessagesResult —

waitForAIMessagesAsync()

Operation waitForAIMessagesAsync

public waitForAIMessagesAsync(WaitForAIMessagesOptions $wait_for_ai_messages_options[, string $idempotency_key = null ][, string $contentType = self::contentTypes['waitForAIMessages'][0] ]) : PromiseInterface

Wait for all named email and SMS expectations under one shared deadline and AI token budget

Parameters
$wait_for_ai_messages_options : WaitForAIMessagesOptions

(required)

$idempotency_key : string = null

(optional)

$contentType : string = self::contentTypes['waitForAIMessages'][0]

The value for the Content-Type header. Check self::contentTypes['waitForAIMessages'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

waitForAIMessagesAsyncWithHttpInfo()

Operation waitForAIMessagesAsyncWithHttpInfo

public waitForAIMessagesAsyncWithHttpInfo(WaitForAIMessagesOptions $wait_for_ai_messages_options[, string $idempotency_key = null ][, string $contentType = self::contentTypes['waitForAIMessages'][0] ]) : PromiseInterface

Wait for all named email and SMS expectations under one shared deadline and AI token budget

Parameters
$wait_for_ai_messages_options : WaitForAIMessagesOptions

(required)

$idempotency_key : string = null

(optional)

$contentType : string = self::contentTypes['waitForAIMessages'][0]

The value for the Content-Type header. Check self::contentTypes['waitForAIMessages'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

waitForAIMessagesRequest()

Create request for operation 'waitForAIMessages'

public waitForAIMessagesRequest(WaitForAIMessagesOptions $wait_for_ai_messages_options[, string $idempotency_key = null ][, string $contentType = self::contentTypes['waitForAIMessages'][0] ]) : Request
Parameters
$wait_for_ai_messages_options : WaitForAIMessagesOptions

(required)

$idempotency_key : string = null

(optional)

$contentType : string = self::contentTypes['waitForAIMessages'][0]

The value for the Content-Type header. Check self::contentTypes['waitForAIMessages'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request —

waitForAIMessagesWithHttpInfo()

Operation waitForAIMessagesWithHttpInfo

public waitForAIMessagesWithHttpInfo(WaitForAIMessagesOptions $wait_for_ai_messages_options[, string $idempotency_key = null ][, string $contentType = self::contentTypes['waitForAIMessages'][0] ]) : array<string|int, mixed>

Wait for all named email and SMS expectations under one shared deadline and AI token budget

Parameters
$wait_for_ai_messages_options : WaitForAIMessagesOptions

(required)

$idempotency_key : string = null

(optional)

$contentType : string = self::contentTypes['waitForAIMessages'][0]

The value for the Content-Type header. Check self::contentTypes['waitForAIMessages'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\AIMessagesResult, HTTP status code, HTTP response headers (array of strings)

waitForAIMessageWithHttpInfo()

Operation waitForAIMessageWithHttpInfo

public waitForAIMessageWithHttpInfo(WaitForAIMessageOptions $wait_for_ai_message_options[, string $idempotency_key = null ][, string $contentType = self::contentTypes['waitForAIMessage'][0] ]) : array<string|int, mixed>

Find a message across explicit inboxes or phones, then assert and extract from that same message

Parameters
$wait_for_ai_message_options : WaitForAIMessageOptions

(required)

$idempotency_key : string = null

(optional)

$contentType : string = self::contentTypes['waitForAIMessage'][0]

The value for the Content-Type header. Check self::contentTypes['waitForAIMessage'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \MailSlurp\Models\AIMessageResult, HTTP status code, HTTP response headers (array of strings)

createHttpClientOption()

Create http client option

protected createHttpClientOption() : array<string|int, mixed>
Tags
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed> —

of http client options

Search results