API Documentation
\
MoxiworksPlatform
Exception

\MoxiworksPlatformGroup

Summary

Methods
Properties
Constants
headers()
authHeader()
acceptHeader()
contentTypeHeader()
userAgentHeader()
apiConnection()
checkForErrorInResponse()
underscore()
__construct()
find()
search()
$moxi_works_agent_id
$agent_uuid
$moxi_works_group_name
$moxi_works_group_id
$transient
$contacts
$page_number
$total_pages
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 a group is associated with. this or agent_uuid must be set for any Moxi Works Platform transaction

$agent_uuid

$agent_uuid : string

Type

string — the Moxi Works UUID of the agent agent_uuid is the ID of the agent which a group is associated with. this or moxi_works_agent_id must be set for any Moxi Works Platform transaction

$moxi_works_group_name

$moxi_works_group_name : string

Type

string — the name of the Group on the Moxi Works Platform

$moxi_works_group_id

$moxi_works_group_id : string

Type

string — the ID of the Group on the Moxi Works Platform

$transient

$transient : boolean

Type

boolean — whether the group ID continues to exist beyond a name change. Some providers (namely versions of Exchange) provide no permanent unique identifier for groups. Group IDs for these providers are inherently transient. Moxi Works has no way to guarantee that any Group marked transient will persist since the name can be changed outside of The Moxi Works platform and Exchange provides no persistent IDs for their Group entities.

$contacts

$contacts : array

Type

array — an array filled with MoxiworksPlatform\Contact objects representing all the Contacts in the specified MoxiworksPlatform\Group This attribute will only be in find responses

$page_number

$page_number :

Type

— integer use this attribute for paging if the number of contacts spans multiple response pages This attribute will only be in find responses

$total_pages

$total_pages :

Type

— integer use this attribute for paging if the number of contacts spans multiple response pages This attribute will only be in find responses

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)

Group constructor.

Parameters

array $data

find()

find(  $opts = array()) : \MoxiworksPlatform\Group|null

Find a specified Group by name on the Moxi Works Platform.

find can be performed including the Moxi Works Group ID and the Moxi Works Agent ID in a parameter array

use MoxiworksPlatform\Group::search to determine what group IDs are available. \MoxiworksPlatform\Group::find([moxi_works_agent_id: 'abc123', moxi_works_group_id: 'groupId'])

Parameters

$opts

Throws

\MoxiworksPlatform\Exception\ArgumentException

if required parameters are not included

\MoxiworksPlatform\RemoteRequestFailureException

Returns

\MoxiworksPlatform\Group|null

search()

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

Search for Groups or return all Groups for an Agent on Moxi Works Platform.

search can be performed by including moxi_works_group_name in parameters \MoxiworksPlatform\Group::search([moxi_works_agent_id: 'abc123', moxi_works_group_name: foo])

Parameters

array $attributes


moxi_works_agent_id either agent_uuid or moxi_works_agent_id are REQUIRED The Moxi Works Agent ID for the agent to which this group is to be associated
agent_uuid either agent_uuid or moxi_works_agent_id are REQUIRED The Moxi Works Agent UUID for the agent to which this group is to be associated
name string The name of the Group on Moxi Works Platform

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 Group objects

sendRequest()

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

Parameters

$method
array $opts
null $url

Throws

\MoxiworksPlatform\Exception\ArgumentException

if required parameters are not included

\MoxiworksPlatform\RemoteRequestFailureException

Returns

\MoxiworksPlatform\Group|null