Overview

Namespaces

  • Angelfon
    • SDK
      • Exceptions
      • Http
      • Rest
        • Api
          • V099
            • User

Classes

  • Api
  • Client
  • Overview
  • Namespace
  • Class

Class Client

A client for accessing the Angelfon API

Namespace: Angelfon\SDK\Rest
Author: Fernando Mora G.
Located at Rest/Client.php
Methods summary
public
# __construct( string $username = null, string $password = null, string $clientId = null, string $clientSecret = null, Angelfon\SDK\Http\Client $httpClient = null, mixed[] $environment = null )

Parameters

$username
Account Username
$password
Account Password
$clientId
Application Client ID
$clientSecret
Application Client Secret
$httpClient
HTTP Client for requests
$environment
Evironment to look for credentials, defaults to $_ENV

Throws

Angelfon\SDK\Exceptions\ConfigurationException
When not valid authentication
public Angelfon\SDK\Http\Response
# request( string $method, string $uri, string[] $params = [], string[] $data = [], string[] $headers = [], string $timeout = null, string $password,…, string $clientId,…, string $clientSecret,…, integer $timeout,… )

Perform a Request using the HTTP Client

Parameters

$method
Http Method
$uri
Fully qualified URL
$params
Query string parameters
$data
POST body data
$headers
HTTP Headers
$timeout
$username Account Username
$password,…
Account Password
$clientId,…
Application Client ID
$clientSecret,…
Application Client Secret
$timeout,…
HTTP Request timeout

Returns

Angelfon\SDK\Http\Response
Response from Angelfon API
public
# obtainAccessToken( )
public string
# getUsername( )

Get current username

Get current username

Returns

string
public string
# getPassword( )

Get current password

Get current password

Returns

string
public integer
# getClientId( )

Get current clientId

Get current clientId

Returns

integer
public string
# getClientSecret( )

Get current clientSecret

Get current clientSecret

Returns

string
public Angelfon\SDK\Http\Client
# getHttpClient( )

Get current HTTP Client

Get current HTTP Client

Returns

Angelfon\SDK\Http\Client
public string
# getAccessToken( )

Get the Angelfon API Access Token

Get the Angelfon API Access Token

Returns

string
public Angelfon\SDK\Rest\Api
# getApi( )

Access the Api Angelfon Domain

Access the Api Angelfon Domain

Returns

Angelfon\SDK\Rest\Api
The Api Domain
protected Angelfon\SDK\Rest\Api\V099\User\CallList
# getCalls( )

Returns

Angelfon\SDK\Rest\Api\V099\User\CallList
protected Angelfon\SDK\Rest\Api\V099\User\SmsContext
# contextSms( string $id )

Parameters

$id
Sms id that uniquely identifies the Sms to fetch

Returns

Angelfon\SDK\Rest\Api\V099\User\SmsContext
protected Angelfon\SDK\Rest\Api\V099\User\SmsList
# getSms( )

Returns

Angelfon\SDK\Rest\Api\V099\User\SmsList
protected Angelfon\SDK\Rest\Api\V099\User\CallContext
# contextCalls( string $id )

Parameters

$id
Call id that uniquely identifies the Call to fetch

Returns

Angelfon\SDK\Rest\Api\V099\User\CallContext
public Angelfon\SDK\Domain
# __get( string $name )

Magic getter to lazy load domains

Magic getter to lazy load domains

Parameters

$name
Domain to return

Returns

Angelfon\SDK\Domain
The requested domain

Throws

Angelfon\SDK\Exceptions\AngelfonException
For unknown domains
public Angelfon\SDK\InstanceContext
# __call( string $name, mixed[] $arguments )

Magic call to lazy load contexts

Magic call to lazy load contexts

Parameters

$name
Context to return
$arguments
Context to return

Returns

Angelfon\SDK\InstanceContext
The requested context

Throws

Angelfon\SDK\Exceptions\AngelfonException
For unknown contexts
Constants summary
string ENV_USERNAME
# "ANGELFON_USERNAME"
string ENV_PASSWORD
# "ANGELFON_PASSWORD"
string ENV_CLIENT_ID
# "ANGELFON_CLIENT_ID"
string ENV_CLIENT_SECRET
# "ANGELFON_CLIENT_SECRET"
Properties summary
protected string $username

Account Username

Account Username

# ''
protected string $password

Account Password

Account Password

# ''
protected integer $clientId

App Client ID

App Client ID

#
protected string $clientSecret

App Client Secret

App Client Secret

# ''
protected Angelfon\SDK\Http\Client $httpClient

HTTP Client

HTTP Client

#
protected string $accessToken

Angelfon API Access Token

Angelfon API Access Token

# ''
protected Angelfon\SDK\Rest\Api $_api

Api domain

Api domain

# null
API documentation generated by ApiGen