PHP Class Zendesk\API\Resources\Core\AppInstallations

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

Protected Properties

Property Type Description
$objectName
$objectNamePlural
$resourceName

Public Methods

Method Description
TraitUpdate ( )
create ( array $params, string $routeKey = __FUNCTION__ ) : null | stdClass Installs an app
jobStatuses ( $jobId ) : stdClass Queries the requirements installation job status using a job id given from the installation step.
requirements ( null $appInstallationId = null, array $params = [] ) : stdClass Lists all Apps Requirements for an installation.
update ( null $id = null, array $updateResourceFields = [], string $routeKey = __FUNCTION__ ) : stdClass Updates the settings for the app installation

Protected Methods

Method Description
setUpRoutes ( )

Method Details

TraitUpdate() public method

public TraitUpdate ( )

create() public method

Installs an app
public create ( array $params, string $routeKey = __FUNCTION__ ) : null | stdClass
$params array
$routeKey string
return null | stdClass

jobStatuses() public method

Queries the requirements installation job status using a job id given from the installation step.
public jobStatuses ( $jobId ) : stdClass
$jobId
return stdClass | null

requirements() public method

Lists all Apps Requirements for an installation.
public requirements ( null $appInstallationId = null, array $params = [] ) : stdClass
$appInstallationId null
$params array
return stdClass | null

setUpRoutes() protected method

protected setUpRoutes ( )

update() public method

Updates the settings for the app installation
public update ( null $id = null, array $updateResourceFields = [], string $routeKey = __FUNCTION__ ) : stdClass
$id null
$updateResourceFields array
$routeKey string
return stdClass | null

Property Details

$objectName protected property

protected $objectName

$objectNamePlural protected property

protected $objectNamePlural

$resourceName protected property

protected $resourceName