API Documentation
\
MoxiworksPlatform
Exception

\MoxiworksPlatformActionLog

Summary

Methods
Properties
Constants
headers()
authHeader()
acceptHeader()
contentTypeHeader()
userAgentHeader()
apiConnection()
checkForErrorInResponse()
underscore()
__construct()
create()
search()
$moxi_works_agent_id
$partner_contact_id
$title
$body
$type
$timestamp
$actions
No constants found
No protected methods found
No protected properties found
N/A
sendRequest()
No private properties found
N/A

Properties

$moxi_works_agent_id

$moxi_works_agent_id : string

Type

string — the Moxi Works Platform ID of the agent moxi_works_agent_id is the Moxi Works Platform ID of the agent which an action log entry is or is to be associated with. this must be set for any ActionLog create transaction

$partner_contact_id

$partner_contact_id : string

Type

string — your system's unique ID for the contact *your system's* unique ID for the Contact this must be set for any ActionLog create transaction

$title

$title : string

Type

string — the title of this ActionLog entry this must be set for any ActionLog create transaction

$body

$body : string

Type

string — the body of this ActionLog entry this must be set for any ActionLog create transaction

$type

$type : string

Type

string — the type of this ActionLog entry

$timestamp

$timestamp : integer

Type

integer — the timestamp of this ActionLog entry

$actions

$actions : array

Type

array — of image associative arrays associated with the listing in the format [ "moxi_works_action_log_id" => "(string) unique identifier for the Moxi Works Platform ActionLog entry", "type" => "(string) the type of ActionLog entry this is. The string should be formatted in lowercase with an underscore between each word", "timestamp" => "(Integer) Unix timestamp for the creation time of the ActionLog entry", "log_data" => "(Dictionary) the payload data of the ActionLog entry. The structure returned is dependent on the kind of ActionLog entry this is" ]

Methods

headers()

headers()

authHeader()

authHeader()

acceptHeader()

acceptHeader()

contentTypeHeader()

contentTypeHeader()

userAgentHeader()

userAgentHeader()

apiConnection()

apiConnection(  $method,   $url,   $attributes)

Parameters

$method
$url
$attributes

checkForErrorInResponse()

checkForErrorInResponse(  $json)

Parameters

$json

underscore()

underscore(  $attr)

Parameters

$attr

__construct()

__construct(array  $data)

ActionLog constructor.

Parameters

array $data

create()

create(array  $attributes = array()) : \MoxiworksPlatform\ActionLog|null

Create an ActionLog entry on The Moxi Works Platform <code> MoxiworksPlatform\ActionLog::create([ moxi_works_agent_id: '123abc', partner_contact_id: '1234', title: 'Client Picked Up House Keys!', body: 'Firstname Lastname came by the office to pick up their keys']); </code>

Parameters

array $attributes


moxi_works_agent_id REQUIRED The Moxi Works Agent ID for the agent to which this ActionLog entry is to be associated
partner_contact_id REQUIRED Your system's unique ID for the contact for whom the ActionLog entry regards.
title string string a short description of the ActionLog entry (should be 85 characters or less)
body string the body of the ActionLog entry (should be 255 characters or less)

Throws

\MoxiworksPlatform\Exception\ArgumentException

if required parameters are not included

\MoxiworksPlatform\RemoteRequestFailureException

Returns

\MoxiworksPlatform\ActionLog|null

search()

search(array  $attributes = array()) : Array

Search ActionLogs for a specific Contact on Moxi Works Platform.

search can be performed by including date_start and date_end in a parameter array \MoxiworksPlatform\Contact::search([moxi_works_agent_id: 'abc123', partner_contact_id: 'abc123'])

Parameters

array $attributes


moxi_works_agent_id REQUIRED string The Moxi Works Agent ID for the agent to which this ActionLog entry is associated
partner_contact_id REQUIRED Your system's unique ID for the contact for whom the ActionLog entry regards.

Throws

\MoxiworksPlatform\Exception\ArgumentException

if required parameters are not included

\MoxiworksPlatform\Exception\ArgumentException

if at least one search parameter is not defined

\MoxiworksPlatform\RemoteRequestFailureException

Returns

Array —

of ActionLog objects

sendRequest()

sendRequest(  $method, array  $opts = array(), null  $url = null) : \MoxiworksPlatform\ActionLog|null

Parameters

$method
array $opts
null $url

Throws

\MoxiworksPlatform\Exception\ArgumentException

if required parameters are not included

\MoxiworksPlatform\RemoteRequestFailureException

Returns

\MoxiworksPlatform\ActionLog|null