API Documentation
\
Cloudonix
Datamodels
Exceptions
Helpers

\CloudonixClient

Cloudonix API.Core Client - Command and Control REST Client

Summary

Methods
Properties
Constants
__construct()
__destruct()
tenants()
domains()
applications()
dnids()
subscribers()
trunks()
httpRequest()
getSelf()
$cacheDirectory
$cacheHandler
$httpEndpoint
$httpClientIdent
$handler
$httpConnector
$httpHeaders
$apikey
$tenantName
$tenantId
No constants found
No protected methods found
$tenantsInterface
$domainsInterface
$applicationsInterface
$subscribersInterface
$trunksInterface
$dnidsInterface
N/A
buildHttpClient()
No private properties found
N/A

Properties

$cacheDirectory

$cacheDirectory : string

Type

string — Directory to store cache files, defaults to `/tmp`

$cacheHandler

$cacheHandler : object

Type

object — The Cache Manager Object

$httpEndpoint

$httpEndpoint : string

Type

string — The Cloudonix API.Core Endpoint URL

$httpClientIdent

$httpClientIdent : string

Type

string — The library identification string

$handler

$handler : object

Type

object — Previously initiated Cloudonix\Client Object

$httpConnector

$httpConnector : object

Type

object — Guzzle HTTP Client Connector

$httpHeaders

$httpHeaders : array

Type

array — HTTP Headers to be used with all Guzzle HTTP Client requests

$apikey

$apikey : string

Type

string — Cloudonix assigned API key for client init

$tenantName

$tenantName : string

Type

string — Cloudonix provisioned Tenant name

$tenantId

$tenantId : integer

Type

integer — Cloudonix provisioned Tenant ID

$tenantsInterface

$tenantsInterface : \Cloudonix\Datamodels\Tenants

Type

\Cloudonix\Datamodels\Tenants — Cloudonix Tenants REST API Connector

$domainsInterface

$domainsInterface : \Cloudonix\Datamodels\Domains

Type

\Cloudonix\Datamodels\Domains — Cloudonix Domains REST API Connector

$applicationsInterface

$applicationsInterface : \Cloudonix\Datamodels\Applications

Type

\Cloudonix\Datamodels\Applications — Cloudonix Applications REST API Connector

$subscribersInterface

$subscribersInterface : \Cloudonix\Datamodels\Subscribers

Type

\Cloudonix\Datamodels\Subscribers — Cloudonix Subscribers REST API Connector

$trunksInterface

$trunksInterface : \Cloudonix\Datamodels\Trunks

Type

\Cloudonix\Datamodels\Trunks — Cloudonix Trunks REST API Connector

$dnidsInterface

$dnidsInterface : \Cloudonix\Datamodels\Dnids

Type

\Cloudonix\Datamodels\Dnids — Cloudonix Dnids REST API Connector

Methods

__construct()

__construct(string  $apikey = null, string  $httpEndpoint = null, string  $cacheDirectory = null, double  $timeout = 2.0)

Client constructor.

Parameters

string $apikey

Cloudonix assigned API key.
string $httpEndpoint

An alternative Cloudonix API Endpoint - default 'https://api.cloudonix.io'
string $cacheDirectory

A designated Cache Memory directory - default '/tmp'
double $timeout

An alternative HTTP timeout value for HTTP requests - default 2.0 seconds

Throws

\Exception

In case of library init error

__destruct()

__destruct()

Client Destructor

httpRequest()

httpRequest(  $method,   $request, null  $data = null) : \stdClass

Issue a REST HTTP request to Cloudonix API endpoint - based on provided information

Parameters

$method
$request
null $data

Throws

\Exception
\GuzzleHttp\Exception\ClientException
\GuzzleHttp\Exception\ServerException

Returns

\stdClass

getSelf()

getSelf() : array

Get Self information for the provided API key

Returns

array

buildHttpClient()

buildHttpClient(string  $apikey, double  $timeout = 2.0) : \GuzzleHttp\Client

Build the Client Guzzle HTTP Client

Parameters

string $apikey

Cloudonix assigned API key.
double $timeout

An alternative HTTP timeout value for HTTP requests

Returns

\GuzzleHttp\Client