\MoxiworksPlatformBrand

Summary

Methods

Properties

Constants

headers()
authHeader()
acceptHeader()
contentTypeHeader()
userAgentHeader()
apiConnection()
checkForErrorInResponse()
underscore()
__construct()
find()
search()

$image_logo
$cma_authoring_color
$background_color
$background_font_color_primary
$button_background_color
$button_font_color
$copyright
$display_name
$email_element_background_color
$image_cma_pdf_logo_header
$image_email_logo_alt
$image_favicon
$image_pres_cover_logo
$pres_block_background_color
$pres_block_text_color

No constants found

No protected methods found

No protected properties found

N/A

sendRequest()

No private properties found

N/A

File: Brand.php
Package: Default
Class hierarchy: \MoxiworksPlatform\Resource

\MoxiworksPlatform\Brand

Tags

None found

Properties

$image_logo

$image_logo : string

Type

string — URL to logo for the company

$cma_authoring_color

$cma_authoring_color : string

Type

string — HTML hexadecimal color code of the presentation accent color for the company

$background_color

$background_color : string

Type

string — HTML hexadecimal color code of the background color for the company

$background_font_color_primary

$background_font_color_primary : string

Type

string — HTML hexadecimal color code of the background font color for the company

$button_background_color

$button_background_color : string

Type

string — HTML hexadecimal color code of the background color for buttons displayed

$button_font_color

$button_font_color : string

Type

string — HTML hexadecimal color code of the font color for buttons displayed

$copyright

$copyright : string

Type

string — copyright declaration for the company. This could include embedded HTML and so should be rendered as if it did.

$display_name

$display_name : string

Type

string — HTML the display name for the company as to be presented to end users

$email_element_background_color

$email_element_background_color : string

Type

string — HTML hexadecimal color code of the background color of email elements for the company

$image_cma_pdf_logo_header

$image_cma_pdf_logo_header : string

Type

string — URL to a logo suitable for placement on a white background (i.e. printing)

$image_email_logo_alt

$image_email_logo_alt : string

Type

string — URL to a logo suitable for placement over the company's email element background color

$image_favicon

$image_favicon : string

Type

string — URL to a favicon image

$image_pres_cover_logo

$image_pres_cover_logo : string

Type

string — URL to a logo suitable for placement over $pres_block_background_color

$pres_block_background_color

$pres_block_background_color : string

Type

string — HTML hexadecimal color code of the background color for the company used in block elements of the company's presentations

$pres_block_text_color

$pres_block_text_color : string

Type

string — HTML hexadecimal color code of a text color suitable for placement over $pres_block_background_color

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)

Brand constructor.

Parameters

array

$data

find()

find(array  $attributes = array()) : \MoxiworksPlatform\Brand|null

Find a Brand on Moxi Works Platform.

find can be performed including the Moxi Works Company ID in a parameter array \MoxiworksPlatform\Brand::find([moxi_works_company_id: 'abc123'])

Parameters

array

$attributes

moxi_works_company_id REQUIRED The Moxi Works Company ID

Throws

\MoxiworksPlatform\Exception\ArgumentException: if required parameters are not included
\MoxiworksPlatform\RemoteRequestFailureException

Returns

\MoxiworksPlatform\Brand|null

search()

search(array  $attributes = array()) : \MoxiworksPlatform\Brand|null

Search for Brands by Agent ID on Moxi Works Platform.

search can be performed by including moxi_works_company_id and updated_since in a parameter array \MoxiworksPlatform\Brand::search([moxi_works_agent_id: 'abc123'])

Parameters

array

$attributes

moxi_works_company_id string The Moxi Works Company ID for the company in which we are searching for brands
moxi_works_agent_id string The Moxi Works Agent ID for the agent in which we are searching for brands

  <h2>
optional Task search parameters

updated_since integer Unix timestamp representing the start time for the search. If no updated_since parameter is included in the request, only agents updated in the last seven days will be included in the response.

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

\MoxiworksPlatform\Brand|null

sendRequest()

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

Parameters

	$method
array	$opts
null	$url

Throws

\MoxiworksPlatform\Exception\ArgumentException: if required parameters are not included
\MoxiworksPlatform\RemoteRequestFailureException

Returns

\MoxiworksPlatform\Brand|null