\FuelSdkET_Message_Guide

The class can get, convert, render, send messages.

Summary

Methods

Properties

Constants

post()
patch()
delete()
get()
getMoreResults()
__construct()
convert()
sendProcess()
render()

$authStub
$props
$organizationId
$organizationKey

No constants found

No protected methods found

$folderProperty
$folderMediaType
$lastPageNumber
$endpoint
$urlProps
$urlPropsRequired

N/A

No private methods found

No private properties found

N/A

Properties

$authStub

$authStub : \FuelSdk\ET_Client

Type

\FuelSdk\ET_Client — The ET client object which performs the auth token, refresh token using clientID clientSecret

$props

$props : array

Type

array — Dictionary type array which may hold e.g. array('id' => '', 'key' => '')

$organizationId

$organizationId : string

Type

string — Organization Identifier.

$organizationKey

$organizationKey : string

Type

string — Organization Key.

$folderProperty

$folderProperty : string

Type

string — Folder property e.g. "Category", "CategoryID", etc.

$folderMediaType

$folderMediaType : string

Type

string — Folder Media Type e.g. "dataextension", "triggered_send", etc.

$lastPageNumber

$lastPageNumber : integer

Type

integer — The last page number

$endpoint

$endpoint : string

Type

string — URL of the API endpoint

$urlProps

$urlProps : array<mixed,string>

Type

array<mixed,string> — array of string having properties or fields name found in the endpoint URL

$urlPropsRequired

$urlPropsRequired : array<mixed,string>

Type

array<mixed,string> — array of string having only required fields

Methods

post()

post() : \FuelSdk\ET_PostRest

Returns

\FuelSdk\ET_PostRest —

Object of type ET_PostRest which contains http status code, response, etc from the POST REST service

patch()

patch() : \FuelSdk\ET_PatchRest

Returns

\FuelSdk\ET_PatchRest —

Object of type ET_PatchRest which contains http status code, response, etc from the PATCH REST service

delete()

delete() : \FuelSdk\ET_DeleteRest

Returns

\FuelSdk\ET_DeleteRest —

Object of type ET_DeleteRest which contains http status code, response, etc from the DELETE REST service

get()

get() : \FuelSdk\ET_GetRest

Returns

\FuelSdk\ET_GetRest —

Object of type ET_GetRest which contains http status code, response, etc from the GET REST service

getMoreResults()

getMoreResults() : \FuelSdk\ET_GetRest

Returns

\FuelSdk\ET_GetRest —

returns more response from the GET REST service of type ET_GetRest Object

__construct()

__construct()

The constructor will assign endpoint, urlProps, urlPropsRequired fields of parent ET_BaseObjectRest

convert()

convert() : \FuelSdk\ET_PostRest

Returns

\FuelSdk\ET_PostRest —

Object of type ET_PostRest which contains http status code, response, etc from the POST REST service

sendProcess()

sendProcess() : \FuelSdk\ET_Post

Returns

\FuelSdk\ET_Post —

Object of type ET_Post which contains http status code, response, etc from the POST SOAP (not REST) service

render()

render() : \FuelSdk\ET_GetRest|\FuelSdk\ET_PosttRest

Returns

\FuelSdk\ET_GetRest|\FuelSdk\ET_PosttRest —

Object of type ET_GetRest or ET_PostRest if props field is an array and holds id as a key