GoogleServicesApiClient
in package
Class GoogleServicesApiClient
Table of Contents
- $httpClient : Client
- $storage : GoogleConfigurationStorage
- __construct() : mixed
- GoogleServicesApiClient constructor.
- call() : ResponseInterface
- Performs a client call to the google services api.
- clientCall() : ResponseInterface
- Performs a client call to the google services api.
- patchClientCall() : ResponseInterface
- Performs a patch client call to the google services api.
- _getGoogleServiceVersion() : string
- Returns the google services module version.
- _getRequestOptions() : array<string|int, mixed>
- Returns the request options.
Properties
$httpClient
protected
Client
$httpClient
$storage
protected
GoogleConfigurationStorage
$storage
Methods
__construct()
GoogleServicesApiClient constructor.
public
__construct(Client $httpClient, GoogleConfigurationStorage $storage) : mixed
Parameters
- $httpClient : Client
- $storage : GoogleConfigurationStorage
Return values
mixed —call()
Performs a client call to the google services api.
public
call(string $endpoint[, array<string|int, mixed> $options = [] ]) : ResponseInterface
All required headers will be set automatically.
Parameters
- $endpoint : string
-
Endpoint url suffix after api version.
- $options : array<string|int, mixed> = []
-
Additional request options for the http client.
Return values
ResponseInterface —clientCall()
Performs a client call to the google services api.
public
clientCall(string $endpoint[, array<string|int, mixed> $options = [] ]) : ResponseInterface
All required headers will be set automatically.
Parameters
- $endpoint : string
-
Endpoint url suffix after api version and /client/[clientCustomerId].
- $options : array<string|int, mixed> = []
-
Additional request options for the http client.
Return values
ResponseInterface —patchClientCall()
Performs a patch client call to the google services api.
public
patchClientCall(string $endpoint, array<string|int, mixed> $json[, array<string|int, mixed> $options = [] ]) : ResponseInterface
All required headers will be set automatically.
Parameters
- $endpoint : string
-
Endpoint url suffix after api version and /client/[clientCustomerId].
- $json : array<string|int, mixed>
-
Data to send, will encoded into a json string.
- $options : array<string|int, mixed> = []
-
Additional request options for the http client.
Return values
ResponseInterface —_getGoogleServiceVersion()
Returns the google services module version.
private
_getGoogleServiceVersion() : string
Return values
string —_getRequestOptions()
Returns the request options.
private
_getRequestOptions([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
All informative required headers will be added to the request options.
Parameters
- $options : array<string|int, mixed> = []
-
(Optional) Options to be merged.
Return values
array<string|int, mixed> —Options for guzzle http request.