AuthResource
extends BaseResource
in package
Table of Contents
Constants
Properties
- $httpClient : HttpClient
Methods
- __construct() : mixed
- getMeEndpoint() : Identity
- Get the identity details of the currently authenticated user.
- getToken() : AuthorizationToken
- Make call to FreshBooks OAuth /token endpoint to fetch access_token and refresh_tokens.
- buildQueryString() : string
- getUrl() : string
- The the url to the resource.
- makeRequest() : array<string|int, mixed>
- Make a request against the accounting resource and return an array of the json response.
Constants
DELETE
protected
mixed
DELETE
= 'DELETE'
GET
protected
mixed
GET
= 'GET'
PATCH
protected
mixed
PATCH
= 'PATCH'
POST
protected
mixed
POST
= 'POST'
PUT
protected
mixed
PUT
= 'PUT'
Properties
$httpClient
private
HttpClient
$httpClient
Methods
__construct()
public
__construct(HttpClient $httpClient) : mixed
Parameters
- $httpClient : HttpClient
getMeEndpoint()
Get the identity details of the currently authenticated user.
public
getMeEndpoint() : Identity
Tags
Return values
Identity —Result object with the authenticated user's identity and business details.
getToken()
Make call to FreshBooks OAuth /token endpoint to fetch access_token and refresh_tokens.
public
getToken(mixed $authParams) : AuthorizationToken
Parameters
- $authParams : mixed
-
OAuth data payload
Return values
AuthorizationToken —Object containing the access toekn, refresh token, and expiry details.
buildQueryString()
protected
buildQueryString(array<string|int, mixed>|null $builders) : string
Parameters
- $builders : array<string|int, mixed>|null
Return values
stringgetUrl()
The the url to the resource.
private
getUrl(string $endpoint) : string
Parameters
- $endpoint : string
Return values
stringmakeRequest()
Make a request against the accounting resource and return an array of the json response.
private
makeRequest(string $method, string $url[, array<string|int, mixed> $data = null ]) : array<string|int, mixed>
Throws a FreshBooksException if the response is not a 200 or if the response cannot be parsed.
Parameters
- $method : string
- $url : string
- $data : array<string|int, mixed> = null