FreshBooksClient
in package
SDK Client.
Table of Contents
Properties
- $httpClient : ClientInterface
- $config : FreshBooksClientConfig
- $requestFactoryInterface : RequestFactoryInterface
- $streamFactoryInterface : StreamFactoryInterface
Methods
- __construct() : mixed
- attachments() : UploadResource
- FreshBooks attachment upload resource with call to upload, get
- callbacks() : EventsResource
- FreshBooks callbacks (webhook callbacks) resource with calls to get, list, create, update, delete, verify, resendVerification
- clients() : AccountingResource
- FreshBooks clients resource with calls to get, list, create, update, delete
- currentUser() : Identity
- The identity details of the currently authenticated user.
- expenseCategories() : AccountingResource
- FreshBooks expenses categories resource with calls to get and list
- expenses() : AccountingResource
- FreshBooks expenses resource with calls to get, list, create, update, delete
- getAccessToken() : AuthorizationToken
- Makes a call to the FreshBooks token URL to get an access_token.
- getAuthRequestUri() : string
- getAuthRequestUri
- getConfig() : FreshBooksClientConfig
- Get the current config.
- images() : UploadResource
- FreshBooks image upload resource with call to upload, get
- invoicePaymentOptions() : PaymentResource
- FreshBooks invoice payment options resource with calls to default, get, create.
- invoices() : AccountingResource
- FreshBooks invoices resource with calls to get, list, create, update, delete
- items() : AccountingResource
- FreshBooks items resource with calls to get, list, create, update, delete
- payments() : AccountingResource
- FreshBooks payments resource with calls to get, list, create, update, delete.
- projects() : ProjectResource
- FreshBooks projects resource with calls to get, list, create, update, delete.
- refreshAccessToken() : AuthorizationToken
- Makes a call to the FreshBooks token URL to refresh an access_token.
- tasks() : AccountingResource
- FreshBooks tasks resource with calls to get, list, create, update, delete
- taxes() : AccountingResource
- FreshBooks taxes resource with calls to get, list, create, update, delete.
- createHttpClient() : HttpMethodsClient
- getHeaders() : array<string|int, mixed>
- getToken() : AuthorizationToken
- Make call to FreshBooks OAuth /token endpoint to fetch access_token and refresh_tokens.
Properties
$httpClient
protected
ClientInterface
$httpClient
$config
private
FreshBooksClientConfig
$config
$requestFactoryInterface
private
RequestFactoryInterface
$requestFactoryInterface
$streamFactoryInterface
private
StreamFactoryInterface
$streamFactoryInterface
Methods
__construct()
public
__construct(string $clientId, mixed $config) : mixed
Parameters
- $clientId : string
- $config : mixed
attachments()
FreshBooks attachment upload resource with call to upload, get
public
attachments() : UploadResource
Return values
UploadResourcecallbacks()
FreshBooks callbacks (webhook callbacks) resource with calls to get, list, create, update, delete, verify, resendVerification
public
callbacks() : EventsResource
Return values
EventsResourceclients()
FreshBooks clients resource with calls to get, list, create, update, delete
public
clients() : AccountingResource
Return values
AccountingResourcecurrentUser()
The identity details of the currently authenticated user.
public
currentUser() : Identity
Tags
Return values
IdentityexpenseCategories()
FreshBooks expenses categories resource with calls to get and list
public
expenseCategories() : AccountingResource
Return values
AccountingResourceexpenses()
FreshBooks expenses resource with calls to get, list, create, update, delete
public
expenses() : AccountingResource
Return values
AccountingResourcegetAccessToken()
Makes a call to the FreshBooks token URL to get an access_token.
public
getAccessToken(mixed $code) : AuthorizationToken
This requires the access_grant code obtained after the user is redirected by the authorization step. See FreshBooksClient::getAuthRequestUri().
This call sets the accessToken, refreshToken, and tokenExpiresAt properties on the
FreshBooksClientConfig instance (see FreshBooksClient::getConfig())
and also returns those values in an AuthorizationToken object.
Parameters
- $code : mixed
-
access grant code from the authorization redirect
Tags
Return values
AuthorizationToken —Object containing the access token, refresh token, and expiry details.
getAuthRequestUri()
getAuthRequestUri
public
getAuthRequestUri([mixed $scopes = null ]) : string
Parameters
- $scopes : mixed = null
Tags
Return values
stringgetConfig()
Get the current config.
public
getConfig() : FreshBooksClientConfig
Return values
FreshBooksClientConfigimages()
FreshBooks image upload resource with call to upload, get
public
images() : UploadResource
Return values
UploadResourceinvoicePaymentOptions()
FreshBooks invoice payment options resource with calls to default, get, create.
public
invoicePaymentOptions() : PaymentResource
Return values
PaymentResourceinvoices()
FreshBooks invoices resource with calls to get, list, create, update, delete
public
invoices() : AccountingResource
Return values
AccountingResourceitems()
FreshBooks items resource with calls to get, list, create, update, delete
public
items() : AccountingResource
Return values
AccountingResourcepayments()
FreshBooks payments resource with calls to get, list, create, update, delete.
public
payments() : AccountingResource
Return values
AccountingResourceprojects()
FreshBooks projects resource with calls to get, list, create, update, delete.
public
projects() : ProjectResource
Return values
ProjectResourcerefreshAccessToken()
Makes a call to the FreshBooks token URL to refresh an access_token.
public
refreshAccessToken([mixed $refreshToken = null ]) : AuthorizationToken
If refreshToken is provided, it will call to refresh it, otherwise it will use the
refreshToken on the FreshBooksClientConfig instance.
This call sets the accessToken, refreshToken, and tokenExpiresAt properties on the
FreshBooksClientConfig instance (see FreshBooksClient::getConfig())
and also returns those values in an AuthorizationToken object.
Parameters
- $refreshToken : mixed = null
-
(Optional) Existing refresh token
Tags
Return values
AuthorizationToken —Object containing the access token, refresh token, and expiry details.
tasks()
FreshBooks tasks resource with calls to get, list, create, update, delete
public
tasks() : AccountingResource
Return values
AccountingResourcetaxes()
FreshBooks taxes resource with calls to get, list, create, update, delete.
public
taxes() : AccountingResource
Return values
AccountingResourcecreateHttpClient()
protected
createHttpClient() : HttpMethodsClient
Return values
HttpMethodsClientgetHeaders()
protected
getHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed>getToken()
Make call to FreshBooks OAuth /token endpoint to fetch access_token and refresh_tokens.
protected
getToken(mixed $grantType, mixed $codeType, mixed $code) : AuthorizationToken
Parameters
- $grantType : mixed
-
The grant type to use
- $codeType : mixed
-
The type of code to use
- $code : mixed
-
The code to use
Tags
Return values
AuthorizationToken —Object containing the access token, refresh token, and expiry details.