| Package | Description |
|---|---|
| uk.co.visalia.brightpearl.apiclient | |
| uk.co.visalia.brightpearl.apiclient.auth |
| Modifier and Type | Method and Description |
|---|---|
BrightpearlApiClient.ApiSession |
BrightpearlApiClient.createSession(AppAuthorisation authorisation)
Creates a session an app and account.
|
MultiResponse |
BrightpearlApiClient.execute(AppAuthorisation authorisation,
MultiRequest multiRequest)
Executes a multi message request.
|
MultiResponse |
BrightpearlApiClient.execute(AppAuthorisation authorisation,
MultiRequestBuilder multiRequestBuilder)
Convenience method equivalent to
BrightpearlApiClient.execute(AppAuthorisation, MultiRequest), this calls MultiRequestBuilder.build()
on the supplied builder for executing the request. |
<T> T |
BrightpearlApiClient.execute(AppAuthorisation authorisation,
ServiceWriteRequest<T> serviceRequest)
Make a POST, PUT or DELETE call to the API.
|
<T> T |
BrightpearlApiClient.execute(AppAuthorisation authorisation,
ServiceWriteRequestBuilder<T> serviceRequestBuilder)
Convenience shortcut for
BrightpearlApiClient.execute(AppAuthorisation, ServiceWriteRequest). |
<T> T |
BrightpearlApiClient.get(AppAuthorisation authorisation,
ServiceReadRequest<T> serviceRequest)
Make a GET or OPTIONS call to the API, and extract the expected response entity from the JSON returned.
|
<T> T |
BrightpearlApiClient.get(AppAuthorisation authorisation,
ServiceReadRequestBuilder<T> serviceRequestBuilder)
Convenience shortcut for
BrightpearlApiClient.get(AppAuthorisation, ServiceReadRequest). |
Response |
BrightpearlApiClient.getHttpResponse(AppAuthorisation authorisation,
AbstractServiceRequest serviceRequest)
Executes a request and returns the response as an unparsed string of JSON together with the HTTP status
code and headers, exactly as returned by the
Client implementation. |
<T> SearchResults<T> |
BrightpearlApiClient.search(AppAuthorisation authorisation,
SearchRequestBuilder<T> serviceRequestBuilder)
Convenience shortcut for
BrightpearlApiClient.search(AppAuthorisation, ServiceSearchRequest). |
<T> SearchResults<T> |
BrightpearlApiClient.search(AppAuthorisation authorisation,
ServiceSearchRequest<T> serviceRequest)
Makes a GET call to a search API, and deserialises the response into a
SearchResults object that contains
meta information, reference data and a list of results. |
| Modifier and Type | Class and Description |
|---|---|
class |
LegacyAuthorisation
Contains a legacy authentication token related to a staff member and not any developer or app.
|
class |
PrivateAppAuthorisation
Contains the details of a private app, the Brightpearl customer account to which it belongs, and either an account token
or a staff token for authorisation of calls to this account.
|
class |
PublicAppAuthorisation
Contains the details of an app, a Brightpearl customer account and the tokens required to verify the app's permission
to make API calls to the account.
|
Copyright © 2014. All Rights Reserved.