Class PipelinerClient

The client context

Namespace: PipelinerSales\ApiClient
Located at PipelinerSales/ApiClient/PipelinerClient.php

Methods summary
`public`	# `__construct( array $entityTypes, PipelinerSales\ApiClient\Repository\RepositoryFactoryInterface $repositoryFactory, PipelinerSales\ApiClient\InfoMethodsInterface $infoMethods )` Constructor. To create a client object configured for most typical uses, use the static `PipelinerSales\ApiClient\PipelinerClient::create()` method. Constructor. To create a client object configured for most typical uses, use the static `PipelinerSales\ApiClient\PipelinerClient::create()` method. Parameters `$entityTypes` an associative array with entity names as keys and their plurals as values `$repositoryFactory` `$infoMethods`
`public static PipelinerSales\ApiClient\PipelinerClient`	# `create( string $url, string $pipelineId, string $apiToken, string $password )` Creates a PipelinerClient object with sensible default configuration. Will perform a HTTP request to fetch the existing entity types for the pipeline. Creates a PipelinerClient object with sensible default configuration. Will perform a HTTP request to fetch the existing entity types for the pipeline. Parameters `$url` base url of the REST server, without the trailing slash `$pipelineId` the unique team pipeline id `$apiToken` API token `$password` API password Returns `PipelinerSales\ApiClient\PipelinerClient` Throws `PipelinerSales\ApiClient\PipelinerClientException` when trying to use an unsupported pipeline version `PipelinerSales\ApiClient\Http\PipelinerHttpException` if fetching the pipeline version fails
`public array`	# `getEntityTypes( )` Returns an associative array of recognized entity names to the plurals of their names Returns an associative array of recognized entity names to the plurals of their names Returns `array`
`public PipelinerSales\ApiClient\InfoMethodsInterface`	# `getServerInfo( )` Returns an object for retrieving various information from the server. Returns an object for retrieving various information from the server. Returns `PipelinerSales\ApiClient\InfoMethodsInterface`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	# `__get( string $name )` Magic getter for repositories. Calls `PipelinerSales\ApiClient\PipelinerClient::getRepository()` for known entity types. Magic getter for repositories. Calls `PipelinerSales\ApiClient\PipelinerClient::getRepository()` for known entity types. Parameters `$name` camelCase name of the collection (e.g. activityTypes) Returns `PipelinerSales\ApiClient\Repository\RepositoryInterface`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	# `getRepository( mixed $entityName )` Returns a repository for the specified entity. Returns a repository for the specified entity. Parameters `$entityName` an `PipelinerSales\ApiClient\Entity` object or entity name, can be both singular (Account) and plural (Accounts) Returns `PipelinerSales\ApiClient\Repository\RepositoryInterface`
`public`	# `getPipelineVersion( )`
`public`	# `registeryEntityType( $entityName, $collectionName )`

Magic properties summary
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$accounts`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$accountTypes`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$activities`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$activityTypes`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$addressbookRelations` (pipeline version 14+)
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$appointments`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$clients`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$competencies` (pipeline version 11-14)
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$contacts`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$currencies`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$data`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$documents`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$emails` (pipeline version 12+)
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$exRateLists`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$industries`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$integrationEnvs`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$leads`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$masterRights`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$messages`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$notes`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$opportunities`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$opptyAccountRelations` (pipeline version 14+)
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$opptyContactRelations` (pipeline version 14+)
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$opptyContactRoles` (pipeline version 15+)
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$opptyProductRelations` (pipeline version 14+)
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$products`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$productCategories` (pipeline version 14+)
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$productPriceLists` (pipeline version 14+)
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$productPriceListPrices` (pipeline version 14+)
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$reasonOfCloses`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$relevancies` (pipeline version 11-14)
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$reminders`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$salesRoles` (pipeline version 15+)
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$salesUnits`
`public PipelinerSales\ApiClient\Repository\RepositoryInterface`	`$stages`

Namespaces

Classes

Interfaces

Exceptions

Class PipelinerClient

Parameters

Parameters

Returns

Throws

Returns

Returns

Parameters

Returns

Parameters

Returns