PHP Class Zendesk\API\Resources\Core\Organizations

Inheritance: extends Zendesk\API\Resources\ResourceAbstract, use trait Zendesk\API\Traits\Utility\InstantiatorTrait, use trait Zendesk\API\Traits\Resource\Defaults, use trait Zendesk\API\Traits\Resource\CreateMany, use trait Zendesk\API\Traits\Resource\DeleteMany, use trait Zendesk\API\Traits\Resource\FindMany, use trait Zendesk\API\Traits\Resource\UpdateMany
Show file Open project: zendesk/zendesk_api_client_php

Public Methods

Method Description
autocomplete ( $name, array $params = [] ) : stdClass Returns an array of organizations whose name starts with the value specified in the name parameter.
getRoute ( $name, array $params = [] ) : mixed Returns a route and replaces tokenized parts of the string with the passed params
getValidSubResources ( )
related ( integer $id ) : stdClass Show an organization's related information
search ( $external_id, array $params = [] ) : stdClass Search organizations by external ID

Protected Methods

Method Description
setUpRoutes ( )

Method Details

autocomplete() public method

The name must be at least 2 characters in length
public autocomplete ( $name, array $params = [] ) : stdClass
$name
$params array
return stdClass | null

getRoute() public method

Returns a route and replaces tokenized parts of the string with the passed params
public getRoute ( $name, array $params = [] ) : mixed
$name
$params array
return mixed The default routes, or if $name is set to `findAll`, any of the following formats based on the parent chain GET /api/v2/organizations.json GET /api/v2/users/{user_id}/organizations.json

getValidSubResources() public static method

public static getValidSubResources ( )

setUpRoutes() protected method

protected setUpRoutes ( )