PHP Class Zendesk\API\Resources\Core\UserIdentities

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

Protected Properties

Property Type Description
$resourceName

Public Methods

Method Description
create ( array $params = [] )
createAsEndUser ( array $params = [] )
delete ( $id = null )
find ( $id = null, array $queryParams = [] )
findAll ( array $params = [] )
makePrimary ( array $params = [] ) : null | stdClass This API method allows you to set an identity to primary.
requestVerification ( array $params = [] ) : null | stdClass This sends a verification email to the user, asking him to click a link in order to verify ownership of the email address
traitCreate ( )
traitDelete ( )
traitFind ( )
traitFindAll ( )
traitUpdate ( )
update ( $id = null, array $updateResourceFields = [] )
verify ( array $params = [] ) : null | stdClass This API method only allows you to set an identity as verified. This is allowed only for agents.

Protected Methods

Method Description
setUpRoutes ( )

Private Methods

Method Description
addUserIdToRouteParams ( array $params ) Get the userId passed as a parameter or as a chained parameter
makePutRequest ( string $callingMethod, array $params = [] ) : stdClass This makes a PUT request to the endpoint defined by the $callingMethod parameter.

Method Details

create() public method

public create ( array $params = [] )
$params array

createAsEndUser() public method

public createAsEndUser ( array $params = [] )
$params array

delete() public method

public delete ( $id = null )

find() public method

public find ( $id = null, array $queryParams = [] )
$queryParams array

findAll() public method

public findAll ( array $params = [] )
$params array

makePrimary() public method

This API method allows you to set an identity to primary.
public makePrimary ( array $params = [] ) : null | stdClass
$params array
return null | stdClass

requestVerification() public method

This sends a verification email to the user, asking him to click a link in order to verify ownership of the email address
public requestVerification ( array $params = [] ) : null | stdClass
$params array
return null | stdClass

setUpRoutes() protected method

protected setUpRoutes ( )

traitCreate() public method

public traitCreate ( )

traitDelete() public method

public traitDelete ( )

traitFind() public method

public traitFind ( )

traitFindAll() public method

public traitFindAll ( )

traitUpdate() public method

public traitUpdate ( )

update() public method

public update ( $id = null, array $updateResourceFields = [] )
$updateResourceFields array

verify() public method

This API method only allows you to set an identity as verified. This is allowed only for agents.
public verify ( array $params = [] ) : null | stdClass
$params array
return null | stdClass

Property Details

$resourceName protected property

protected $resourceName