PHP Class Zendesk\API\Resources\Core\Macros

Inheritance: extends Zendesk\API\Resources\ResourceAbstract, use trait Zendesk\API\Traits\Resource\Defaults
Show file Open project: zendesk/zendesk_api_client_php

Public Methods

Method Description
apply ( $id ) : mixed Returns the changes the macro would make to a ticket.
applyToTicket ( $id, $ticketId ) : stdClass Returns the full ticket object as it would be after applying the macro to the ticket.
findAllActive ( array $params = [] ) : stdClass Lists all active shared and personal macros available to the current user

Protected Methods

Method Description
setUpRoutes ( ) Declares routes to be used by this resource.

Method Details

apply() public method

Returns the changes the macro would make to a ticket.
public apply ( $id ) : mixed
$id
return mixed

applyToTicket() public method

Returns the full ticket object as it would be after applying the macro to the ticket.
public applyToTicket ( $id, $ticketId ) : stdClass
$id
$ticketId
return stdClass | null

findAllActive() public method

Lists all active shared and personal macros available to the current user
public findAllActive ( array $params = [] ) : stdClass
$params array
return stdClass | null

setUpRoutes() protected method

Declares routes to be used by this resource.
protected setUpRoutes ( )