Index (uk.co.visalia.brightpearl:api-client 1.0.0 API)

A B C D E F G H I J L M N O P R S T U V W

A

AbstractServiceRequest<T> - Class in uk.co.visalia.brightpearl.apiclient.request: This is the superclass for read and write request classes, providing the functionality common to both.
Account - Class in uk.co.visalia.brightpearl.apiclient.account: Defines a Brightpearl customer account.
Account(Datacenter, String) - Constructor for class uk.co.visalia.brightpearl.apiclient.account.Account: Construct an account instance.
ACCOUNT_TOKEN_HEADER - Static variable in interface uk.co.visalia.brightpearl.apiclient.auth.AppAuthorisation
ACCOUNTING - Static variable in class uk.co.visalia.brightpearl.apiclient.ServiceName
add(Integer...) - Method in class uk.co.visalia.brightpearl.apiclient.common.IdSet: Add IDs from an array or varargs argument.
add(Collection<Integer>) - Method in class uk.co.visalia.brightpearl.apiclient.common.IdSet: Add IDs from a collection.
addRange(int, int) - Method in class uk.co.visalia.brightpearl.apiclient.common.IdSet: Add a range of IDs.
all() - Static method in class uk.co.visalia.brightpearl.apiclient.common.IdSet: Initialise an empty ID set.
any() - Static method in class uk.co.visalia.brightpearl.apiclient.common.IdSet: Initialise an empty ID set.
APP_HEADER - Static variable in interface uk.co.visalia.brightpearl.apiclient.auth.AppAuthorisation
AppAuthorisation - Interface in uk.co.visalia.brightpearl.apiclient.auth: Interface for classes that combine details of an an app with details of an account, providing account details and authentication headers for BrightpearlApiClient.
authenticate() - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlLegacyApiSession: Authenticates this session.

B

Base64 - Class in uk.co.visalia.brightpearl.apiclient.util: Functions used internally, available in other libraries but replicated to avoid unwanted dependencies.
Base64() - Constructor for class uk.co.visalia.brightpearl.apiclient.util.Base64
BrightpearlApiClient - Class in uk.co.visalia.brightpearl.apiclient: Main client class for the Brightpearl API.
brightpearlApiClient() - Static method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClientFactory: Static builder method for method chaining, fluent builder style.
BrightpearlApiClient.ApiSession - Class in uk.co.visalia.brightpearl.apiclient: An authenticated API session configured with a Brightpearl customer account and headers needed to authenticate calls for a single app of any type.
BrightpearlApiClientFactory - Class in uk.co.visalia.brightpearl.apiclient: Constructs a configured BrightpearlApiClient.
BrightpearlApiClientFactory() - Constructor for class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClientFactory
BrightpearlAuthException - Exception in uk.co.visalia.brightpearl.apiclient.exception: Thrown within BrightpearlApiClient when a 401 response is received from the Brightpearl API.
BrightpearlAuthException() - Constructor for exception uk.co.visalia.brightpearl.apiclient.exception.BrightpearlAuthException
BrightpearlAuthException(String) - Constructor for exception uk.co.visalia.brightpearl.apiclient.exception.BrightpearlAuthException
BrightpearlClientException - Exception in uk.co.visalia.brightpearl.apiclient.exception: This is the superclass for exceptions thrown by this client library.
BrightpearlClientException(String) - Constructor for exception uk.co.visalia.brightpearl.apiclient.exception.BrightpearlClientException
BrightpearlClientException(String, Exception) - Constructor for exception uk.co.visalia.brightpearl.apiclient.exception.BrightpearlClientException
BrightpearlHttpException - Exception in uk.co.visalia.brightpearl.apiclient.exception: Subclass of BrightpearlClientException thrown when a request fails due to an HTTP transport error, and when a response is received but cannot be parsed into the type expected.
BrightpearlHttpException(ClientErrorCode) - Constructor for exception uk.co.visalia.brightpearl.apiclient.exception.BrightpearlHttpException
BrightpearlHttpException(ClientErrorCode, String) - Constructor for exception uk.co.visalia.brightpearl.apiclient.exception.BrightpearlHttpException
BrightpearlHttpException(ClientErrorCode, Exception) - Constructor for exception uk.co.visalia.brightpearl.apiclient.exception.BrightpearlHttpException
BrightpearlLegacyApiSession - Class in uk.co.visalia.brightpearl.apiclient: For use with Brightpearl's old method of authentication - staff tokens access using staff email address and password.
BrightpearlLegacyApiSessionFactory - Class in uk.co.visalia.brightpearl.apiclient: A factory class used to create BrightpearlLegacyApiSessions, which are specific to a Brightpearl account.
BrightpearlLegacyApiSessionFactory() - Constructor for class uk.co.visalia.brightpearl.apiclient.BrightpearlLegacyApiSessionFactory
BrightpearlRequestCapException - Exception in uk.co.visalia.brightpearl.apiclient.exception: This exception is thrown when a request cap error is detected, caused by too many requests being made to a single account.
BrightpearlRequestCapException(String) - Constructor for exception uk.co.visalia.brightpearl.apiclient.exception.BrightpearlRequestCapException
BrightpearlRequestCapException(String, Exception) - Constructor for exception uk.co.visalia.brightpearl.apiclient.exception.BrightpearlRequestCapException
BrightpearlServiceException - Exception in uk.co.visalia.brightpearl.apiclient.exception: This exception is thrown by the simple get, search and execute APIs in BrightpearlApiClient when the Brightpearl API returns a collection of error messages in the JSON response body.
BrightpearlServiceException(int, List<ServiceError>) - Constructor for exception uk.co.visalia.brightpearl.apiclient.exception.BrightpearlServiceException
BrightpearlUnavailableException - Exception in uk.co.visalia.brightpearl.apiclient.exception: This exception is thrown when a 503 is received from Brightpearl but the message does not indicate the request cap has been reached.
BrightpearlUnavailableException(String) - Constructor for exception uk.co.visalia.brightpearl.apiclient.exception.BrightpearlUnavailableException
BrightpearlUnavailableException(String, Exception) - Constructor for exception uk.co.visalia.brightpearl.apiclient.exception.BrightpearlUnavailableException
build() - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClientFactory: Constructs the immutable BrightpearlApiClient with configuration options provided, using defaults for any not set.
build() - Method in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactoryBuilder: Builds an immutable HttpClient4ClientFactory instance with the configuration supplied.
build() - Method in class uk.co.visalia.brightpearl.apiclient.http.RequestBuilder: Constructs the immutable Request instance.
build() - Method in class uk.co.visalia.brightpearl.apiclient.http.ResponseBuilder: Builds and returns an immutable Response instance.
build() - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.MultiRequestBuilder: Constructs the immutable MultiRequest instance.
build() - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.MultiResponseBuilder: Constructs the immutable MultiResponse instance.
build() - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.ServiceResponseBuilder: Constructs the immutable MultiResponse instance.
build() - Method in interface uk.co.visalia.brightpearl.apiclient.request.SearchRequestBuilder: Build an immutable request instance for execution.
build() - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceReadRequestBuilder: Builds an immutable request instance from values provided to this builder.
build() - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceReadRequestSetBuilder: Builds an immutable request set instance from values provided to this builder.
build() - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceSearchRequestBuilder: Constructs the immutable request instance for execution.
build() - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceWriteRequestBuilder: Builds an immutable request instance from values provided to this builder.

C

CalendarAdaptor - Class in uk.co.visalia.brightpearl.apiclient.client.adaptors: A custom GSON serialiser and deserialiser implementation that supports Calendars represented as ISO date times.
CalendarAdaptor() - Constructor for class uk.co.visalia.brightpearl.apiclient.client.adaptors.CalendarAdaptor
Client - Interface in uk.co.visalia.brightpearl.apiclient.http: A simple interface for an HTTP client, providing a generic API that can be implemented using any HTTP client library, to make this client library fully portable.
ClientErrorCode - Enum in uk.co.visalia.brightpearl.apiclient.exception: To aid in troubleshooting problems, these standardised error codes are included in BrightpearlHttpExceptions whenever possible.
ClientFactory - Interface in uk.co.visalia.brightpearl.apiclient.http: Interface for classes that create Clients.
COLUMNS_PARAM - Static variable in class uk.co.visalia.brightpearl.apiclient.request.ServiceSearchRequestBuilder
ConstantWaitRateLimiter - Class in uk.co.visalia.brightpearl.apiclient.ratelimit: A very basic implementation of RateLimiter that will reduce the throughput of requests by pausing for the minimum period required to ensure the cap is not exceeded.
ConstantWaitRateLimiter() - Constructor for class uk.co.visalia.brightpearl.apiclient.ratelimit.ConstantWaitRateLimiter: Construct a constant wait rate limiter with the default settings, limiting requests to 200 per minute.
ConstantWaitRateLimiter(int, int, TimeUnit) - Constructor for class uk.co.visalia.brightpearl.apiclient.ratelimit.ConstantWaitRateLimiter: Construct a constant wait limiter with a custom rate limit.
CONTACT - Static variable in class uk.co.visalia.brightpearl.apiclient.ServiceName
create(Account, String) - Static method in class uk.co.visalia.brightpearl.apiclient.auth.PrivateAppIdentity: Create a private app identity.
create(String, String) - Static method in class uk.co.visalia.brightpearl.apiclient.auth.PublicAppIdentity: Create a public app identity where the secret will not be required, either because all authentication will use staff tokens or because account tokens will be supplied already signed.
create(String, String, String) - Static method in class uk.co.visalia.brightpearl.apiclient.auth.PublicAppIdentity: Create a public app identity with an optional developer secret for signing account tokens.
createSession(AppAuthorisation) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient: Creates a session an app and account.

D

Datacenter - Class in uk.co.visalia.brightpearl.apiclient.account: Represents the datacenter on which an account is hosted.
Datacenter(String, String) - Constructor for class uk.co.visalia.brightpearl.apiclient.account.Datacenter: Create a custom datacenter.
DateTimeAdaptor - Class in uk.co.visalia.brightpearl.apiclient.client.adaptors: A custom GSON serialiser and deserialiser implementation that supports DateTimes represented as ISO date times.
DateTimeAdaptor() - Constructor for class uk.co.visalia.brightpearl.apiclient.client.adaptors.DateTimeAdaptor
DEFAULT_ALLOW_REDIRECTS - Static variable in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactory
DEFAULT_CONNECTION_MANAGER_TIMEOUT_MS - Static variable in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactory
DEFAULT_CONNECTION_TIMEOUT_MS - Static variable in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactory
DEFAULT_MAX_CONNECTIONS - Static variable in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactory
DEFAULT_MAX_CONNECTIONS_PER_ROUTE - Static variable in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactory
DEFAULT_SOCKET_TIMEOUT_MS - Static variable in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactory
DEV_HEADER - Static variable in interface uk.co.visalia.brightpearl.apiclient.auth.AppAuthorisation

E

encode(String) - Static method in class uk.co.visalia.brightpearl.apiclient.util.Base64
equals(Object) - Method in class uk.co.visalia.brightpearl.apiclient.account.Account
equals(Object) - Method in class uk.co.visalia.brightpearl.apiclient.account.Datacenter
equals(Object) - Method in class uk.co.visalia.brightpearl.apiclient.account.UserCredentials
equals(Object) - Method in class uk.co.visalia.brightpearl.apiclient.auth.LegacyAuthorisation
equals(Object) - Method in class uk.co.visalia.brightpearl.apiclient.auth.PrivateAppAuthorisation
equals(Object) - Method in class uk.co.visalia.brightpearl.apiclient.auth.PrivateAppIdentity
equals(Object) - Method in class uk.co.visalia.brightpearl.apiclient.auth.PublicAppAuthorisation
equals(Object) - Method in class uk.co.visalia.brightpearl.apiclient.auth.PublicAppIdentity
equals(Object) - Method in class uk.co.visalia.brightpearl.apiclient.common.IdSet
equals(Object) - Method in class uk.co.visalia.brightpearl.apiclient.common.OptionsResponse: Considers two objects to be equal if they have the same class and all their fields are equal.
equals(Object) - Method in class uk.co.visalia.brightpearl.apiclient.common.ServiceError
equals(Object) - Method in class uk.co.visalia.brightpearl.apiclient.http.Request
equals(Object) - Method in class uk.co.visalia.brightpearl.apiclient.http.Response
equals(Object) - Method in class uk.co.visalia.brightpearl.apiclient.ServiceName
equals(String, String) - Static method in class uk.co.visalia.brightpearl.apiclient.util.StringUtils
EU1 - Static variable in class uk.co.visalia.brightpearl.apiclient.account.Datacenter: Datacenter EU1 (GMT, CET).
EU2 - Static variable in class uk.co.visalia.brightpearl.apiclient.account.Datacenter: Datacenter EU2 (for accounts where admin domain is https://secure2.thisispearl.com).
execute(ServiceWriteRequestBuilder<T>) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient.ApiSession: Convenience shortcut for BrightpearlApiClient.ApiSession.execute(uk.co.visalia.brightpearl.apiclient.request.ServiceWriteRequest).
execute(ServiceWriteRequest<T>) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient.ApiSession: Make a POST, PUT or DELETE call to the API.
execute(MultiRequestBuilder) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient.ApiSession: Convenience method equivalent to BrightpearlApiClient.ApiSession.execute(MultiRequest), this calls MultiRequestBuilder.build() on the supplied builder for executing the request.
execute(MultiRequest) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient.ApiSession: Executes a multi message request.
execute(AppAuthorisation, MultiRequestBuilder) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient: Convenience method equivalent to BrightpearlApiClient.execute(AppAuthorisation, MultiRequest), this calls MultiRequestBuilder.build() on the supplied builder for executing the request.
execute(AppAuthorisation, MultiRequest) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient: Executes a multi message request.
execute(AppAuthorisation, ServiceWriteRequestBuilder<T>) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient: Convenience shortcut for BrightpearlApiClient.execute(AppAuthorisation, ServiceWriteRequest).
execute(AppAuthorisation, ServiceWriteRequest<T>) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient: Make a POST, PUT or DELETE call to the API.
execute(ServiceWriteRequestBuilder<T>) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlLegacyApiSession: Executes a write (PUT, POST, DELETE) request and returns the parsed response if the request was successful.
execute(ServiceWriteRequest<T>) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlLegacyApiSession: Executes a write (PUT, POST, DELETE) request and returns the parsed response if the request was successful.
execute(MultiRequestBuilder) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlLegacyApiSession: Executes a multimessage and returns the parsed responses and error messages.
execute(MultiRequest) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlLegacyApiSession: Executes a multimessage and returns the parsed responses and error messages.
execute(Request) - Method in interface uk.co.visalia.brightpearl.apiclient.http.Client: Executes a request and returns the response.
execute(Request) - Method in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4Client: Executes a request and returns the response.
ExpiredAuthTokenStrategy - Enum in uk.co.visalia.brightpearl.apiclient.config: A setting for the BrightpearlLegacyApiSession, this determines whether the session should attempt to reauthenticate with configured credentials when a 401 Unauthorized response is received from the Brightpearl API, which indicates the auth token has expired.

F

FAIL - Static variable in class uk.co.visalia.brightpearl.apiclient.config.RequestCapStrategy: Fail strategy: Do not attempt to repeat requests until they succeed; throw an exception for every failure.
fetchLegacyAuthToken(Account, UserCredentials) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient: Using Brightpearl account details and user credentials, attempts authentication of the user and returns an auth token if the request was successful.
fetchStaffToken(PrivateAppIdentity, UserCredentials) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient: Using private app details and user credentials, attempts authentication of the user and returns their staff token if they are authorised to use the app.
fetchStaffToken(PublicAppIdentity, Account, UserCredentials) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient: Using private app details and user credentials, attempts authentication of the user and returns their staff token if they are authorised to use the app.
FIRST_RESULT_COLUMN - Static variable in class uk.co.visalia.brightpearl.apiclient.request.ServiceSearchRequestBuilder
forName(String) - Static method in class uk.co.visalia.brightpearl.apiclient.account.Datacenter: Looks up a known datacenter by name, similar to looking up an enum by name.

G

get(ServiceReadRequestBuilder<T>) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient.ApiSession: Convenience shortcut for BrightpearlApiClient.ApiSession.get(ServiceReadRequest).
get(ServiceReadRequest<T>) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient.ApiSession: Make a GET or OPTIONS call to the API, and extract the expected response entity from the JSON returned.
get(AppAuthorisation, ServiceReadRequestBuilder<T>) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient: Convenience shortcut for BrightpearlApiClient.get(AppAuthorisation, ServiceReadRequest).
get(AppAuthorisation, ServiceReadRequest<T>) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient: Make a GET or OPTIONS call to the API, and extract the expected response entity from the JSON returned.
get(ServiceReadRequestBuilder<T>) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlLegacyApiSession: Executes a GET or OPTIONs request and returns the parsed response if the request was successful.
get(ServiceReadRequest<T>) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlLegacyApiSession: Executes a GET or OPTIONs request and returns the parsed response if the request was successful.
getAccount() - Method in interface uk.co.visalia.brightpearl.apiclient.auth.AppAuthorisation: Returns the Brightpearl customer's account.
getAccount() - Method in class uk.co.visalia.brightpearl.apiclient.auth.LegacyAuthorisation
getAccount() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PrivateAppAuthorisation
getAccount() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PrivateAppIdentity
getAccount() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PublicAppAuthorisation
getAccountCode() - Method in class uk.co.visalia.brightpearl.apiclient.account.Account
getAccountToken() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PrivateAppAuthorisation
getAccountToken() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PublicAppAuthorisation
getApiAccountCredentials() - Method in class uk.co.visalia.brightpearl.apiclient.client.UserCredentialsWrapper
getAppIdentity() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PrivateAppAuthorisation
getAppIdentity() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PublicAppAuthorisation
getAppReference() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PrivateAppIdentity
getAppReference() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PublicAppIdentity
getBody() - Method in class uk.co.visalia.brightpearl.apiclient.client.multimessage.MultiMessageItem
getBody() - Method in class uk.co.visalia.brightpearl.apiclient.client.multimessage.MultiMessageResponseItem
getBody() - Method in class uk.co.visalia.brightpearl.apiclient.http.Request: JSON request body for inclusion in PUT and POST requests.
getBody() - Method in class uk.co.visalia.brightpearl.apiclient.http.Response: Returns the JSON response body.
getClient(Account) - Method in interface uk.co.visalia.brightpearl.apiclient.http.ClientFactory: Get a client to be used for a given Account.
getClient(Account) - Method in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactory: Returns the same instance of HttpClient4Client, backed by a DefaultHttpClient instance using a thread-safe pooled connection manager, in response to every request.
getClientErrorCode() - Method in exception uk.co.visalia.brightpearl.apiclient.exception.BrightpearlHttpException
getCode() - Method in class uk.co.visalia.brightpearl.apiclient.common.ServiceError: Returns the error code identifying the error.
getColumns() - Method in class uk.co.visalia.brightpearl.apiclient.search.SearchMetaData: Details of all the columns available from a search resource.
getColumns() - Method in class uk.co.visalia.brightpearl.apiclient.search.SearchResultsMetaData: The columns included in the response.
getContent() - Method in class uk.co.visalia.brightpearl.apiclient.client.multimessage.MultiMessageResponseItemBody
getDatacenter() - Method in class uk.co.visalia.brightpearl.apiclient.account.Account: Returns the datacenter
getDeveloperReference() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PublicAppIdentity
getDeveloperSecret() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PublicAppIdentity
getDirection() - Method in class uk.co.visalia.brightpearl.apiclient.search.SearchSort
getEmailAddress() - Method in class uk.co.visalia.brightpearl.apiclient.account.UserCredentials: Returns the email address.
getEntity() - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceWriteRequest: The entity to be serialised as JSON and sent as the request body.
getErrors() - Method in class uk.co.visalia.brightpearl.apiclient.client.parsing.JsonWrapper
getErrors() - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.ServiceResponse: Returns any errors included in the response body.
getFilterable() - Method in class uk.co.visalia.brightpearl.apiclient.search.SearchColumn
getFilterable() - Method in class uk.co.visalia.brightpearl.apiclient.search.SearchSort
getFirstResult() - Method in class uk.co.visalia.brightpearl.apiclient.search.SearchResultsMetaData: Returns the position of the first result on the current page.
getGetUris() - Method in class uk.co.visalia.brightpearl.apiclient.common.OptionsResponse: Returns the set of URIs.
getHeader(String) - Method in class uk.co.visalia.brightpearl.apiclient.http.Response: A utility method that looks up the value of a named header.
getHeaders() - Method in interface uk.co.visalia.brightpearl.apiclient.auth.AppAuthorisation: Returns authentication headers required for requests made to the customer's account.
getHeaders() - Method in class uk.co.visalia.brightpearl.apiclient.auth.LegacyAuthorisation
getHeaders() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PrivateAppAuthorisation
getHeaders() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PublicAppAuthorisation
getHeaders() - Method in class uk.co.visalia.brightpearl.apiclient.http.Request: HTTP headers for addition to the request.
getHeaders() - Method in class uk.co.visalia.brightpearl.apiclient.http.Response: Returns the response headers.
getHost() - Method in class uk.co.visalia.brightpearl.apiclient.account.Datacenter: Returns the datacenter host, including its scheme.
getHttpMethod() - Method in class uk.co.visalia.brightpearl.apiclient.client.multimessage.MultiMessageItem
getHttpResponse(AbstractServiceRequest) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient.ApiSession: 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.
getHttpResponse(AppAuthorisation, AbstractServiceRequest) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient: 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.
getIds() - Method in class uk.co.visalia.brightpearl.apiclient.common.IdSet: Returns the IDs as a Set.
getLabel() - Method in class uk.co.visalia.brightpearl.apiclient.client.multimessage.MultiMessageItem
getLabel() - Method in class uk.co.visalia.brightpearl.apiclient.client.multimessage.MultiMessageResponseItem
getLastResult() - Method in class uk.co.visalia.brightpearl.apiclient.search.SearchResultsMetaData: Returns the position of the last result on the current page.
getMessage() - Method in class uk.co.visalia.brightpearl.apiclient.common.ServiceError: A human readable description of the error, sometimes with additional details of its cause.
getMessages() - Method in class uk.co.visalia.brightpearl.apiclient.client.multimessage.MultiMessage
getMetaData() - Method in class uk.co.visalia.brightpearl.apiclient.client.parsing.PartialSearchResponse
getMetaData() - Method in class uk.co.visalia.brightpearl.apiclient.search.SearchResults
getMethod() - Method in class uk.co.visalia.brightpearl.apiclient.http.Request: The HTTP method.
getMethod() - Method in class uk.co.visalia.brightpearl.apiclient.request.AbstractServiceRequest: The HTTP method of the request.
getName() - Method in class uk.co.visalia.brightpearl.apiclient.account.Datacenter: Returns the name of the datacenter.
getName() - Method in class uk.co.visalia.brightpearl.apiclient.search.SearchColumn
getOnFail() - Method in class uk.co.visalia.brightpearl.apiclient.client.multimessage.MultiMessage
getOnFailOption() - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.MultiRequest: The on fail option (STOP or CONTINUE) set on the request, defining whether remaining requests should still be executed when one fails.
getParameters() - Method in class uk.co.visalia.brightpearl.apiclient.http.Request: Parameters for addition to the URL querystring.
getParams() - Method in class uk.co.visalia.brightpearl.apiclient.request.AbstractServiceRequest: Querystring parameters to be added to the URL.
getPassword() - Method in class uk.co.visalia.brightpearl.apiclient.account.UserCredentials: Returns the password.
getPath() - Method in class uk.co.visalia.brightpearl.apiclient.request.AbstractServiceRequest: Returns the path of the Brightpearl resource within the service given by AbstractServiceRequest.getService().
getPath() - Method in class uk.co.visalia.brightpearl.apiclient.ServiceName: Returns the URI component for the service, for example "product-service".
getProcessedMessages() - Method in class uk.co.visalia.brightpearl.apiclient.client.multimessage.MultiMessageResponse
getProcessingMode() - Method in class uk.co.visalia.brightpearl.apiclient.client.multimessage.MultiMessage
getProcessingMode() - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.MultiRequest: The processing mode option (SEQUENTIAL or PARALLEL) set on the request, which defines whether requests should be executed in serial or in parallel by the Brightpearl multimessage API.
getReference() - Method in class uk.co.visalia.brightpearl.apiclient.client.parsing.JsonWrapper
getReference() - Method in class uk.co.visalia.brightpearl.apiclient.search.SearchResults
getReferenceData() - Method in class uk.co.visalia.brightpearl.apiclient.search.SearchColumn
getReportDataType() - Method in class uk.co.visalia.brightpearl.apiclient.search.SearchColumn
getRequest(String) - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.MultiRequest: Returns an individual request by its unique ID.
getRequests() - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.MultiRequest: The list of requests included in the multimessage batch.
getRequests() - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceReadRequestSet
getRequired() - Method in class uk.co.visalia.brightpearl.apiclient.search.SearchColumn
getResponse() - Method in class uk.co.visalia.brightpearl.apiclient.client.parsing.JsonWrapper
getResponse() - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.ServiceResponse: Returns the parsed entity parsed from the response element of the JSON, in the type expected for the request sent.
getResponseType() - Method in class uk.co.visalia.brightpearl.apiclient.request.AbstractServiceRequest: A generic type token representing the expected type of the response element in the JSON response body.
getResults() - Method in class uk.co.visalia.brightpearl.apiclient.client.parsing.PartialSearchResponse
getResults() - Method in class uk.co.visalia.brightpearl.apiclient.search.SearchResults
getResultsAvailable() - Method in class uk.co.visalia.brightpearl.apiclient.search.SearchResultsMetaData: Returns the total number of results that matched the filters supplied.
getResultsReturned() - Method in class uk.co.visalia.brightpearl.apiclient.search.SearchResultsMetaData: Returns the number of results included on the current page.
getRetryAttempts() - Method in class uk.co.visalia.brightpearl.apiclient.config.RequestCapStrategy: For a retry strategy, returns the number of attempts that will be made to retry a request before aborting.
getRetryWait() - Method in class uk.co.visalia.brightpearl.apiclient.config.RequestCapStrategy: For a retry strategy, returns the wait period between attempts.
getRuid() - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.ServiceResponse: Returns the unique ID of the request sent.
getRuid() - Method in class uk.co.visalia.brightpearl.apiclient.request.AbstractServiceRequest: A unique identifier for the request.
getService() - Method in class uk.co.visalia.brightpearl.apiclient.request.AbstractServiceRequest: Returns the name of the Brightpearl service that contains the resource to be called.
getServiceErrors() - Method in exception uk.co.visalia.brightpearl.apiclient.exception.BrightpearlServiceException: Returns service errors from the response.
getServiceResponse(ServiceWriteRequest<T>) - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.MultiResponse: Fetches the response for an individual request included in the multimessage, using the request's unique ID.
getServiceResponse(String) - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.MultiResponse: Fetches the response for an individual request included in the multimessage, using the request's unique ID.
getSize() - Method in class uk.co.visalia.brightpearl.apiclient.common.IdSet: Returns the number of IDs in the set.
getSortable() - Method in class uk.co.visalia.brightpearl.apiclient.search.SearchColumn
getSorting() - Method in class uk.co.visalia.brightpearl.apiclient.search.SearchMetaData: Describes the default sorting applied.
getSorting() - Method in class uk.co.visalia.brightpearl.apiclient.search.SearchResultsMetaData: The sorting applied to the results.
getStaffToken() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PrivateAppAuthorisation
getStaffToken() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PublicAppAuthorisation
getStatus() - Method in exception uk.co.visalia.brightpearl.apiclient.exception.BrightpearlServiceException: Returns the HTTP status of the response received.
getStatus() - Method in class uk.co.visalia.brightpearl.apiclient.http.Response: Returns the HTTP status of the response.
getStatus() - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.MultiResponse: Returns the status code for the multimessage container request.
getStatus() - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.ServiceResponse: Returns the HTTP status code received.
getStatusCode() - Method in class uk.co.visalia.brightpearl.apiclient.client.multimessage.MultiMessageResponseItem
getThis() - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceReadRequestBuilder
getThis() - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceSearchRequestBuilder
getThis() - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceWriteRequestBuilder
getTimestamp() - Method in class uk.co.visalia.brightpearl.apiclient.http.Response: Returns the timestamp this response instance was created.
getUnprocessedMessages() - Method in class uk.co.visalia.brightpearl.apiclient.client.multimessage.MultiMessageResponse
getUnprocessedRequestRuids() - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.MultiResponse: Returns the list of unique request IDs that were not processed due to earlier failures.
getUri() - Method in class uk.co.visalia.brightpearl.apiclient.client.multimessage.MultiMessageItem
getUrl() - Method in class uk.co.visalia.brightpearl.apiclient.http.Request: The full URL of a Brightpearl API resource.

H

hashCode() - Method in class uk.co.visalia.brightpearl.apiclient.account.Account
hashCode() - Method in class uk.co.visalia.brightpearl.apiclient.account.Datacenter
hashCode() - Method in class uk.co.visalia.brightpearl.apiclient.account.UserCredentials
hashCode() - Method in class uk.co.visalia.brightpearl.apiclient.auth.LegacyAuthorisation
hashCode() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PrivateAppAuthorisation
hashCode() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PrivateAppIdentity
hashCode() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PublicAppAuthorisation
hashCode() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PublicAppIdentity
hashCode() - Method in class uk.co.visalia.brightpearl.apiclient.common.IdSet
hashCode() - Method in class uk.co.visalia.brightpearl.apiclient.common.OptionsResponse: Returns a hashCode calculated from all fields.
hashCode() - Method in class uk.co.visalia.brightpearl.apiclient.common.ServiceError
hashCode() - Method in class uk.co.visalia.brightpearl.apiclient.http.Request
hashCode() - Method in class uk.co.visalia.brightpearl.apiclient.http.Response
hashCode() - Method in class uk.co.visalia.brightpearl.apiclient.ServiceName
HttpClient4Client - Class in uk.co.visalia.brightpearl.apiclient.http.httpclient4: Implementation of Client using Apache HTTP Components HttpClient.
HttpClient4ClientFactory - Class in uk.co.visalia.brightpearl.apiclient.http.httpclient4: An implementation of ClientFactory that creates a single Apache HTTP Components DefaultHttpClient instance using a PoolingClientConnectionManager to provide pooling and thread safety, and returns this wrapped in a HttpClient4Client instance in response to all requests tp HttpClient4ClientFactory.getClient(Account).
httpClient4ClientFactory() - Static method in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactoryBuilder: Static builder method for method chaining, fluent builder style.
HttpClient4ClientFactoryBuilder - Class in uk.co.visalia.brightpearl.apiclient.http.httpclient4: Constructs a configured HttpClient4ClientFactory.
HttpClient4ClientFactoryBuilder() - Constructor for class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactoryBuilder

I

ids(Integer...) - Static method in class uk.co.visalia.brightpearl.apiclient.common.IdSet: Initialise an ID set containing IDs from an array or varargs argument.
ids(Collection<Integer>) - Static method in class uk.co.visalia.brightpearl.apiclient.common.IdSet: Initialise an ID set containing a collection of IDs.
IdSet - Class in uk.co.visalia.brightpearl.apiclient.common: Many of Brightpearl's GET APIs, and some searches and destructive resources, allow multiple IDs to be fetched or modified in one request by specifying comma or dot separated ID ranges (e.g.
IdSet() - Constructor for class uk.co.visalia.brightpearl.apiclient.common.IdSet: Initialise a new empty ID set.
IdSet(Integer...) - Constructor for class uk.co.visalia.brightpearl.apiclient.common.IdSet: Initialise an ID set containing IDs from an array or varargs argument.
IdSet(Collection<Integer>) - Constructor for class uk.co.visalia.brightpearl.apiclient.common.IdSet: Initialise an ID set containing a collection of IDs.
INTEGRATION - Static variable in class uk.co.visalia.brightpearl.apiclient.ServiceName
isBlank(String) - Static method in class uk.co.visalia.brightpearl.apiclient.util.StringUtils
isEmpty() - Method in class uk.co.visalia.brightpearl.apiclient.common.IdSet: Returns true if this set contains no IDs.
isEmpty(String) - Static method in class uk.co.visalia.brightpearl.apiclient.util.StringUtils
isNotBlank(String) - Static method in class uk.co.visalia.brightpearl.apiclient.util.StringUtils
isNotEmpty(String) - Static method in class uk.co.visalia.brightpearl.apiclient.util.StringUtils
isSuccess() - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.ServiceResponse: Returns false if there were errors in the response body, regardless of the status code, or there was an error parsing the response for this individual request.
iterator() - Method in class uk.co.visalia.brightpearl.apiclient.common.IdSet: Returns an iterator over the set of IDs.
iterator() - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceReadRequestSet

J

join(Collection<String>, String) - Static method in class uk.co.visalia.brightpearl.apiclient.util.StringUtils
JsonWrapper - Class in uk.co.visalia.brightpearl.apiclient.client.parsing: For internal use only.
JsonWrapper() - Constructor for class uk.co.visalia.brightpearl.apiclient.client.parsing.JsonWrapper

L

LEGACY_AUTH_HEADER - Static variable in interface uk.co.visalia.brightpearl.apiclient.auth.AppAuthorisation
LegacyAuthorisation - Class in uk.co.visalia.brightpearl.apiclient.auth: Contains a legacy authentication token related to a staff member and not any developer or app.

M

Method - Enum in uk.co.visalia.brightpearl.apiclient.http: Represents the HTTP methods used by the Brightpearl API.
MultiMessage - Class in uk.co.visalia.brightpearl.apiclient.client.multimessage: For internal use only.
MultiMessage(ProcessingMode, OnFailOption, List<MultiMessageItem>) - Constructor for class uk.co.visalia.brightpearl.apiclient.client.multimessage.MultiMessage
MultiMessageItem - Class in uk.co.visalia.brightpearl.apiclient.client.multimessage: For internal use only.
MultiMessageItem(String, String, Method, Object) - Constructor for class uk.co.visalia.brightpearl.apiclient.client.multimessage.MultiMessageItem
MultiMessageResponse - Class in uk.co.visalia.brightpearl.apiclient.client.multimessage: For internal use only.
MultiMessageResponse() - Constructor for class uk.co.visalia.brightpearl.apiclient.client.multimessage.MultiMessageResponse
MultiMessageResponseItem - Class in uk.co.visalia.brightpearl.apiclient.client.multimessage: For internal use only.
MultiMessageResponseItem() - Constructor for class uk.co.visalia.brightpearl.apiclient.client.multimessage.MultiMessageResponseItem
MultiMessageResponseItemBody - Class in uk.co.visalia.brightpearl.apiclient.client.multimessage: For internal use only.
MultiMessageResponseItemBody() - Constructor for class uk.co.visalia.brightpearl.apiclient.client.multimessage.MultiMessageResponseItemBody
MultiMessageUtils - Class in uk.co.visalia.brightpearl.apiclient.multimessage: Utilities for multimessage requests.
MultiRequest - Class in uk.co.visalia.brightpearl.apiclient.multimessage: Wraps a set of write requests together with a OnFailOption and a ProcessingMode to define a multimessage request for execution with the Brightpearl API.
MultiRequestBuilder - Class in uk.co.visalia.brightpearl.apiclient.multimessage: A builder used to create immutable instances of MultiRequest.
MultiResponse - Class in uk.co.visalia.brightpearl.apiclient.multimessage: Contains the results of a multimessage request.
MultiResponseBuilder - Class in uk.co.visalia.brightpearl.apiclient.multimessage: A builder used to create immutable instances of MultiResponse.

N

newApiSession() - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlLegacyApiSessionFactory: Creates a new session using configured credentials.
newApiSessionFactory() - Static method in class uk.co.visalia.brightpearl.apiclient.BrightpearlLegacyApiSessionFactory: Creates a new session factory instance.
newDeleteRequest(ServiceName, String, Class<T>) - Static method in class uk.co.visalia.brightpearl.apiclient.request.ServiceWriteRequestBuilder: Creates a new DELETE request builder configured with the URL to call and expected response type.
newDeleteRequest(ServiceName, String, Type) - Static method in class uk.co.visalia.brightpearl.apiclient.request.ServiceWriteRequestBuilder: Creates a new DELETE request builder configured with the URL to call and expected response type.
newGetRequest(ServiceName, String, Class<T>) - Static method in class uk.co.visalia.brightpearl.apiclient.request.ServiceReadRequestBuilder: Creates a new GET request builder configured with the URL to call and expected response type.
newGetRequest(ServiceName, String, Type) - Static method in class uk.co.visalia.brightpearl.apiclient.request.ServiceReadRequestBuilder: Creates a new GET request builder configured with the URL to call and expected response type.
newMultiRequest() - Static method in class uk.co.visalia.brightpearl.apiclient.multimessage.MultiRequestBuilder: Returns a new builder instance used to create immutable MultiRequest instances
newMultiResponse() - Static method in class uk.co.visalia.brightpearl.apiclient.multimessage.MultiResponseBuilder: Returns a new builder instance used to create immutable MultiResponse instances
newOptionsRequest(ServiceName, String, Class<T>) - Static method in class uk.co.visalia.brightpearl.apiclient.request.ServiceReadRequestBuilder: Creates a new OPTIONS request builder configured with the URL to call and expected response type.
newOptionsRequest(ServiceName, String, Type) - Static method in class uk.co.visalia.brightpearl.apiclient.request.ServiceReadRequestBuilder: Creates a new OPTIONS request builder configured with the URL to call and expected response type.
newPostRequest(ServiceName, String, Object, Class<T>) - Static method in class uk.co.visalia.brightpearl.apiclient.request.ServiceWriteRequestBuilder: Creates a new POST request builder configured with the URL to call and expected response type.
newPostRequest(ServiceName, String, Object, Type) - Static method in class uk.co.visalia.brightpearl.apiclient.request.ServiceWriteRequestBuilder: Creates a new POST request builder configured with the URL to call and expected response type.
newPreauthenticatedApiSession(String) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlLegacyApiSessionFactory: Creates a new session pre-authenticated with a token generated independently.
newPutRequest(ServiceName, String, Object, Class<T>) - Static method in class uk.co.visalia.brightpearl.apiclient.request.ServiceWriteRequestBuilder: Creates a new PUT request builder configured with the URL to call and expected response type.
newPutRequest(ServiceName, String, Object, Type) - Static method in class uk.co.visalia.brightpearl.apiclient.request.ServiceWriteRequestBuilder: Creates a new PUT request builder configured with the URL to call and expected response type.
newReadRequestSet(Class<T>) - Static method in class uk.co.visalia.brightpearl.apiclient.request.ServiceReadRequestSetBuilder: Creates a new paged GET request builder configured with the URL to call and expected response type.
newReadRequestSet() - Static method in class uk.co.visalia.brightpearl.apiclient.request.ServiceReadRequestSetBuilder: Creates a new paged GET request builder configured with the URL to call and expected response type.
newRequest() - Static method in class uk.co.visalia.brightpearl.apiclient.http.RequestBuilder: Creates a new builder instance.
newResponse() - Static method in class uk.co.visalia.brightpearl.apiclient.http.ResponseBuilder: Creates a new builder instance.
newSearchRequest(ServiceName, String, Class<T>) - Static method in class uk.co.visalia.brightpearl.apiclient.request.ServiceSearchRequestBuilder: Creates a new search request builder configured with the URL to call and expected response type.
newSearchRequest(ServiceName, String, Type) - Static method in class uk.co.visalia.brightpearl.apiclient.request.ServiceSearchRequestBuilder: Creates a new search request builder configured with the URL to call and expected response type.
newServiceResponse() - Static method in class uk.co.visalia.brightpearl.apiclient.multimessage.ServiceResponseBuilder: Returns a new builder instance used to create immutable MultiResponse instances
NoOpRateLimiter - Class in uk.co.visalia.brightpearl.apiclient.ratelimit: An implementation of RateLimiter that allows requests to be sent to Brightpearl as fast as they are made by the client.
NoOpRateLimiter() - Constructor for class uk.co.visalia.brightpearl.apiclient.ratelimit.NoOpRateLimiter

O

OnFailOption - Enum in uk.co.visalia.brightpearl.apiclient.multimessage: An instruction to the Brightpearl Multi-Message API that determines what the behaviour should be when one request in a multi-message fails.
OptionsResponse - Class in uk.co.visalia.brightpearl.apiclient.common: The standard response from a Brightpearl OPTIONs API.
OptionsResponse() - Constructor for class uk.co.visalia.brightpearl.apiclient.common.OptionsResponse
ORDER - Static variable in class uk.co.visalia.brightpearl.apiclient.ServiceName

P

PAGE_SIZE_COLUMN - Static variable in class uk.co.visalia.brightpearl.apiclient.request.ServiceSearchRequestBuilder
parse(String) - Static method in class uk.co.visalia.brightpearl.apiclient.common.IdSet: Parse the string representation of an ID set.
PartialSearchResponse - Class in uk.co.visalia.brightpearl.apiclient.client.parsing: For internal use only.
PartialSearchResponse() - Constructor for class uk.co.visalia.brightpearl.apiclient.client.parsing.PartialSearchResponse
PrivateAppAuthorisation - Class in uk.co.visalia.brightpearl.apiclient.auth: 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.
PrivateAppIdentity - Class in uk.co.visalia.brightpearl.apiclient.auth: Contains the identity of a private app, which is specific to a single Brightpearl account.
ProcessingMode - Enum in uk.co.visalia.brightpearl.apiclient.multimessage: A hint to the Brightpearl API whether the requests in a multi-message are safe to be executed concurrently.
PRODUCT - Static variable in class uk.co.visalia.brightpearl.apiclient.ServiceName
PublicAppAuthorisation - Class in uk.co.visalia.brightpearl.apiclient.auth: 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.
PublicAppIdentity - Class in uk.co.visalia.brightpearl.apiclient.auth: Contains the identity details of a public app.

R

range(int, int) - Static method in class uk.co.visalia.brightpearl.apiclient.common.IdSet: Initialise an ID set with a single range of IDs.
rateLimit(Account) - Method in class uk.co.visalia.brightpearl.apiclient.ratelimit.ConstantWaitRateLimiter: Called before a request is made, this sleeps for the minimum amount of time that must be left to ensure no more than the maximum number of requests are made in the configured period.
rateLimit(Account) - Method in class uk.co.visalia.brightpearl.apiclient.ratelimit.NoOpRateLimiter: This implementation does nothing.
rateLimit(Account) - Method in interface uk.co.visalia.brightpearl.apiclient.ratelimit.RateLimiter: Called immediately before a request is made to the Brightpearl API for the given account.
RateLimiter - Interface in uk.co.visalia.brightpearl.apiclient.ratelimit: An interface for rate limiters, which are called before any request is made to the Brightpearl API and notified when a request cap error is received.
read(JsonReader) - Method in class uk.co.visalia.brightpearl.apiclient.client.adaptors.CalendarAdaptor
read(JsonReader) - Method in class uk.co.visalia.brightpearl.apiclient.client.adaptors.DateTimeAdaptor
ReferenceField - Annotation Type in uk.co.visalia.brightpearl.apiclient.request: An annotation for search result domain object fields where the field is populated from a reference data map included in the search result.
ReferenceKey - Annotation Type in uk.co.visalia.brightpearl.apiclient.request: An annotation for search result domain object fields where the field is a key to one or more reference data maps that provide values for other fields on the same domain object.
Request - Class in uk.co.visalia.brightpearl.apiclient.http: Contains the basic details of an HTTP request to be executed by a Client in a generic form that can be supported by any implementation.
RequestBuilder - Class in uk.co.visalia.brightpearl.apiclient.http: A builder used to create immutable Request instances.
requestCapExceeded(Account) - Method in class uk.co.visalia.brightpearl.apiclient.ratelimit.ConstantWaitRateLimiter: This implementation does nothing.
requestCapExceeded(Account) - Method in class uk.co.visalia.brightpearl.apiclient.ratelimit.NoOpRateLimiter: This implementation does nothing.
requestCapExceeded(Account) - Method in interface uk.co.visalia.brightpearl.apiclient.ratelimit.RateLimiter: Called when a request to an account has been rejected due to request throttling.
RequestCapStrategy - Class in uk.co.visalia.brightpearl.apiclient.config: Defines the strategy BrightpearlApiClient should use when a request cap error is received from the Brightpearl API, in terms on the number of retries and wait between them.
requestCompleted(Account, int, long) - Method in class uk.co.visalia.brightpearl.apiclient.ratelimit.ConstantWaitRateLimiter: This implementation does nothing.
requestCompleted(Account, int, long) - Method in class uk.co.visalia.brightpearl.apiclient.ratelimit.NoOpRateLimiter: This implementation does nothing.
requestCompleted(Account, int, long) - Method in interface uk.co.visalia.brightpearl.apiclient.ratelimit.RateLimiter: Called after every request is made to the Brightpearl API, with values from the brightpearl-requests-remaining and brightpearl-next-throttle-period headers.
Response - Class in uk.co.visalia.brightpearl.apiclient.http: Contains the basic details of an HTTP response received from the Brightpearl API.
ResponseBuilder - Class in uk.co.visalia.brightpearl.apiclient.http: A builder used to create immutable Response instances.
RETRY - Static variable in class uk.co.visalia.brightpearl.apiclient.config.RequestCapStrategy: Default retry configuration: Make one attempt every 15 seconds and fail if 5 successive retries are blocked by the request cap.
retry(int, long) - Static method in class uk.co.visalia.brightpearl.apiclient.config.RequestCapStrategy: Constructs a retry strategy with a custom number of retry attempts and wait period in ms.

S

search(SearchRequestBuilder<T>) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient.ApiSession: Convenience shortcut for BrightpearlApiClient.ApiSession.search(uk.co.visalia.brightpearl.apiclient.request.ServiceSearchRequest).
search(ServiceSearchRequest<T>) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient.ApiSession: 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.
search(AppAuthorisation, SearchRequestBuilder<T>) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient: Convenience shortcut for BrightpearlApiClient.search(AppAuthorisation, ServiceSearchRequest).
search(AppAuthorisation, ServiceSearchRequest<T>) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClient: 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.
search(SearchRequestBuilder<T>) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlLegacyApiSession: Executes a search request and returns the parsed response if the request was successful.
search(ServiceSearchRequest<T>) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlLegacyApiSession: Executes a search request and returns the parsed response if the request was successful.
SearchColumn - Class in uk.co.visalia.brightpearl.apiclient.search: Details of a column available for retrieving, filtering or sorting in a search API.
SearchColumn() - Constructor for class uk.co.visalia.brightpearl.apiclient.search.SearchColumn
SearchMetaData - Class in uk.co.visalia.brightpearl.apiclient.search: Contains details of the columns available from a search resource, and the default sorting applied.
SearchMetaData() - Constructor for class uk.co.visalia.brightpearl.apiclient.search.SearchMetaData
SearchRequestBuilder<T> - Interface in uk.co.visalia.brightpearl.apiclient.request: A common interface for builders that create ServiceSearchRequests.
SearchResults<T> - Class in uk.co.visalia.brightpearl.apiclient.search: Contains the full details of a search result.
SearchResults(SearchResultsMetaData, List<T>, Map<String, Map<String, Object>>) - Constructor for class uk.co.visalia.brightpearl.apiclient.search.SearchResults
SearchResultsMetaData - Class in uk.co.visalia.brightpearl.apiclient.search: Contains the metadata of a response from a search resource, describing which search columns were returned, the sort order applied, and the number of available results.
SearchResultsMetaData() - Constructor for class uk.co.visalia.brightpearl.apiclient.search.SearchResultsMetaData
SearchSort - Class in uk.co.visalia.brightpearl.apiclient.search: Describes sorting that was applied to a search result.
SearchSort() - Constructor for class uk.co.visalia.brightpearl.apiclient.search.SearchSort
ServiceError - Class in uk.co.visalia.brightpearl.apiclient.common: Details of a single error message returned in the errors element of a JSON response.
ServiceError(String, String) - Constructor for class uk.co.visalia.brightpearl.apiclient.common.ServiceError
ServiceName - Class in uk.co.visalia.brightpearl.apiclient: An extendable enum containing the known Brightpearl services and allowing a custom service name to be used.
ServiceName(String) - Constructor for class uk.co.visalia.brightpearl.apiclient.ServiceName: Constructs a custom service name instance, using the path, for example "product-service".
ServiceReadRequest<T> - Class in uk.co.visalia.brightpearl.apiclient.request: Represents a read request to be made to the Brightpearl API.
ServiceReadRequestBuilder<T> - Class in uk.co.visalia.brightpearl.apiclient.request: A factory for immutable ServiceReadRequest instances.
ServiceReadRequestSet<T> - Class in uk.co.visalia.brightpearl.apiclient.request: An iterable set of read requests returned from ServiceReadRequestBuilder.
ServiceReadRequestSetBuilder<T> - Class in uk.co.visalia.brightpearl.apiclient.request: A factory for immutable ServiceReadRequestSet instances.
ServiceReadRequestSetBuilder() - Constructor for class uk.co.visalia.brightpearl.apiclient.request.ServiceReadRequestSetBuilder
ServiceResponse<T> - Class in uk.co.visalia.brightpearl.apiclient.multimessage: Contains the response for an individual request executed in a multimessage batch.
ServiceResponseBuilder<T> - Class in uk.co.visalia.brightpearl.apiclient.multimessage: A builder used to create immutable instances of ServiceResponse.
ServiceSearchRequest<T> - Class in uk.co.visalia.brightpearl.apiclient.request: An extension of ServiceReadRequest used for resource searches.
ServiceSearchRequestBuilder<T> - Class in uk.co.visalia.brightpearl.apiclient.request: A builder used to construct generic ServiceSearchRequest instances that may be used against any search resource.
ServiceWriteRequest<T> - Class in uk.co.visalia.brightpearl.apiclient.request: Represents a write request to be made to the Brightpearl API.
ServiceWriteRequestBuilder<T> - Class in uk.co.visalia.brightpearl.apiclient.request: A factory for immutable ServiceWriteRequest instances.
setAccount(Account) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlLegacyApiSessionFactory: Set the target Brightpearl customer account for sessions created by this factory.
setAllowRedirects(boolean) - Method in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactoryBuilder: Set whether redirects should be followed.
setBrightpearlApiClient(BrightpearlApiClient) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlLegacyApiSessionFactory: Set the underlying BrightpearlApiClient that requests are sent to for execution.
setClientFactory(ClientFactory) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClientFactory: Set the ClientFactory that will supply Client instances for the execution of HTTP requests.
setConnectionManagerTimeoutMs(int) - Method in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactoryBuilder: Sets the connection manager timeout in milliseconds.
setConnectionTimeoutMs(int) - Method in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactoryBuilder: Set the time in milliseconds to wait for a connection to be established before aborting the request.
setExpiredAuthTokenStrategy(ExpiredAuthTokenStrategy) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlLegacyApiSessionFactory: Set the strategy to use when credentials authentication is configured and the current auth token expires.
setGson(Gson) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClientFactory: Provide a custom GSON instance for serialising JSON request bodies and deserialising JSON responses.
setMaxConnections(int) - Method in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactoryBuilder: Set the maximum total connections allowed across all routes.
setMaxConnectionsPerRoute(int) - Method in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactoryBuilder: Set the maximum connections allowed per route.
setRateLimiter(RateLimiter) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClientFactory: Set the RateLimiter implementation to be used for monitoring and limiting request throughput.
setSocketTimeoutMs(int) - Method in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactoryBuilder: Maximum time of inactivity to allow between two consecutive data packets from the server before aborting the request.
setUserCredentials(UserCredentials) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlLegacyApiSessionFactory: Set the credentials of an API-enabled user account associated with the customer account.
SORT_PARAM - Static variable in class uk.co.visalia.brightpearl.apiclient.request.ServiceSearchRequestBuilder
SortDirection - Enum in uk.co.visalia.brightpearl.apiclient.request: Sort directions accepted by search resources.
split(int) - Method in class uk.co.visalia.brightpearl.apiclient.common.IdSet: Splits this IdSet into batches of the given size.
split(MultiRequest) - Static method in class uk.co.visalia.brightpearl.apiclient.multimessage.MultiMessageUtils: Splits a MultiRequest into as many requests as necessary to give no more than ten request, whilst also avoiding batches of one request (except when the supplied request contains only one request).
staff(Account, String) - Static method in class uk.co.visalia.brightpearl.apiclient.auth.LegacyAuthorisation: Create legacy authentication details using an account and staff token.
staff(PrivateAppIdentity, String) - Static method in class uk.co.visalia.brightpearl.apiclient.auth.PrivateAppAuthorisation: Create account authorisation details for a staff authorised API call for a private app.
staff(PublicAppIdentity, Account, String) - Static method in class uk.co.visalia.brightpearl.apiclient.auth.PublicAppAuthorisation: Create account authorisation details for a staff authorised API call.
STAFF_TOKEN_HEADER - Static variable in interface uk.co.visalia.brightpearl.apiclient.auth.AppAuthorisation
StringUtils - Class in uk.co.visalia.brightpearl.apiclient.util: A set of functions used internally, mostly replicated from commons-lang to avoid unwanted dependencies.
system(PrivateAppIdentity, String) - Static method in class uk.co.visalia.brightpearl.apiclient.auth.PrivateAppAuthorisation: Create account authorisation details for a private (own account) system-to-system call using the account token generated for a private app.
system(PublicAppIdentity, Account, String) - Static method in class uk.co.visalia.brightpearl.apiclient.auth.PublicAppAuthorisation: Create account authorisation details for a system-to-system call using an account token.

T

toString() - Method in class uk.co.visalia.brightpearl.apiclient.account.Account
toString() - Method in class uk.co.visalia.brightpearl.apiclient.account.Datacenter
toString() - Method in class uk.co.visalia.brightpearl.apiclient.account.UserCredentials
toString() - Method in class uk.co.visalia.brightpearl.apiclient.auth.LegacyAuthorisation
toString() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PrivateAppAuthorisation
toString() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PrivateAppIdentity
toString() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PublicAppAuthorisation
toString() - Method in class uk.co.visalia.brightpearl.apiclient.auth.PublicAppIdentity
toString() - Method in class uk.co.visalia.brightpearl.apiclient.common.IdSet: Creates a string representation of the ID set for inclusion in URLs.
toString() - Method in class uk.co.visalia.brightpearl.apiclient.common.OptionsResponse: Returns a string representation of this class including all its fields and those of its nested objects.
toString() - Method in class uk.co.visalia.brightpearl.apiclient.common.ServiceError
toString() - Method in class uk.co.visalia.brightpearl.apiclient.http.Request
toString() - Method in class uk.co.visalia.brightpearl.apiclient.http.Response
toString() - Method in class uk.co.visalia.brightpearl.apiclient.ServiceName

U

uk.co.visalia.brightpearl.apiclient - package uk.co.visalia.brightpearl.apiclient
uk.co.visalia.brightpearl.apiclient.account - package uk.co.visalia.brightpearl.apiclient.account
uk.co.visalia.brightpearl.apiclient.auth - package uk.co.visalia.brightpearl.apiclient.auth
uk.co.visalia.brightpearl.apiclient.client - package uk.co.visalia.brightpearl.apiclient.client
uk.co.visalia.brightpearl.apiclient.client.adaptors - package uk.co.visalia.brightpearl.apiclient.client.adaptors
uk.co.visalia.brightpearl.apiclient.client.multimessage - package uk.co.visalia.brightpearl.apiclient.client.multimessage
uk.co.visalia.brightpearl.apiclient.client.parsing - package uk.co.visalia.brightpearl.apiclient.client.parsing
uk.co.visalia.brightpearl.apiclient.common - package uk.co.visalia.brightpearl.apiclient.common
uk.co.visalia.brightpearl.apiclient.config - package uk.co.visalia.brightpearl.apiclient.config
uk.co.visalia.brightpearl.apiclient.exception - package uk.co.visalia.brightpearl.apiclient.exception
uk.co.visalia.brightpearl.apiclient.http - package uk.co.visalia.brightpearl.apiclient.http
uk.co.visalia.brightpearl.apiclient.http.httpclient4 - package uk.co.visalia.brightpearl.apiclient.http.httpclient4
uk.co.visalia.brightpearl.apiclient.multimessage - package uk.co.visalia.brightpearl.apiclient.multimessage
uk.co.visalia.brightpearl.apiclient.ratelimit - package uk.co.visalia.brightpearl.apiclient.ratelimit
uk.co.visalia.brightpearl.apiclient.request - package uk.co.visalia.brightpearl.apiclient.request
uk.co.visalia.brightpearl.apiclient.search - package uk.co.visalia.brightpearl.apiclient.search
uk.co.visalia.brightpearl.apiclient.util - package uk.co.visalia.brightpearl.apiclient.util
USE - Static variable in class uk.co.visalia.brightpearl.apiclient.account.Datacenter: Datacenter USE (EST, CST).
UserCredentials - Class in uk.co.visalia.brightpearl.apiclient.account: Contains the email address and password of an account user with API access to be used for authentication.
UserCredentials(String, String) - Constructor for class uk.co.visalia.brightpearl.apiclient.account.UserCredentials: Create an immutable credentials instance with a supplied email address and password.
UserCredentialsWrapper - Class in uk.co.visalia.brightpearl.apiclient.client: Wraps API user credentials to create an object that's serialised to the correct JSON for the authorisation API.
UserCredentialsWrapper(UserCredentials) - Constructor for class uk.co.visalia.brightpearl.apiclient.client.UserCredentialsWrapper
USW - Static variable in class uk.co.visalia.brightpearl.apiclient.account.Datacenter: Datacenter USW (PST, MST).

V

valueOf(String) - Static method in enum uk.co.visalia.brightpearl.apiclient.config.ExpiredAuthTokenStrategy: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum uk.co.visalia.brightpearl.apiclient.exception.ClientErrorCode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum uk.co.visalia.brightpearl.apiclient.http.Method: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum uk.co.visalia.brightpearl.apiclient.multimessage.OnFailOption: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum uk.co.visalia.brightpearl.apiclient.multimessage.ProcessingMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum uk.co.visalia.brightpearl.apiclient.request.SortDirection: Returns the enum constant of this type with the specified name.
values() - Static method in enum uk.co.visalia.brightpearl.apiclient.config.ExpiredAuthTokenStrategy: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum uk.co.visalia.brightpearl.apiclient.exception.ClientErrorCode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum uk.co.visalia.brightpearl.apiclient.http.Method: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum uk.co.visalia.brightpearl.apiclient.multimessage.OnFailOption: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum uk.co.visalia.brightpearl.apiclient.multimessage.ProcessingMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum uk.co.visalia.brightpearl.apiclient.request.SortDirection: Returns an array containing the constants of this enum type, in the order they are declared.

W

WAREHOUSE - Static variable in class uk.co.visalia.brightpearl.apiclient.ServiceName
withAccount(Account) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlLegacyApiSessionFactory: Set the target Brightpearl customer account for sessions created by this factory.
withAddedColumn(String) - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceSearchRequestBuilder: Adds a column to be included in search results.
withAddedFilter(String, String) - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceSearchRequestBuilder: Add an additional column value filter to be applied to the search.
withAddedFilters(Map<String, String>) - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceSearchRequestBuilder: Add additional column value filters to be applied to the search, preserving previous filters set on this builder.
withAddedParam(String, String) - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceReadRequestSetBuilder: Add an additional unencoded querystring parameter to be added to every request, preserving the existing set but overwriting any param with the same name.
withAddedParams(Map<String, String>) - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceReadRequestSetBuilder: Add additional unencoded querystring parameters to be added to every request, preserving the existing set but overwriting any param with the same names.
withAddedRequest(ServiceWriteRequest) - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.MultiRequestBuilder: Add a request to the multimessage batch.
withAddedRequest(ServiceWriteRequestBuilder) - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.MultiRequestBuilder: Add a request to the multimessage batch.
withAddedRequest(ServiceReadRequestBuilder<T>) - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceReadRequestSetBuilder: Adds a request to the batch.
withAddedRequest(ServiceReadRequest<T>) - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceReadRequestSetBuilder: Adds a request to the batch.
withAddedRequests(Set<ServiceReadRequest<T>>) - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceReadRequestSetBuilder: Adds a set of requests to the batch.
withAddedSort(String, SortDirection) - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceSearchRequestBuilder: Add an additional column sort to be applied to the search.
withAllowRedirects(boolean) - Method in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactoryBuilder: Set whether redirects should be followed.
withBody(String) - Method in class uk.co.visalia.brightpearl.apiclient.http.RequestBuilder: Add a JSON body to a PUT or POST request.
withBody(String) - Method in class uk.co.visalia.brightpearl.apiclient.http.ResponseBuilder: Set the JSON body received.
withBrightpearlApiClient(BrightpearlApiClient) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlLegacyApiSessionFactory: Set the underlying BrightpearlApiClient that requests are sent to for execution.
withClientFactory(ClientFactory) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClientFactory: Set the ClientFactory that will supply Client instances for the execution of HTTP requests.
withColumns(String...) - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceSearchRequestBuilder: Sets the columns to be included in search results, replacing any previously set.
withColumns(List<String>) - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceSearchRequestBuilder: Sets the columns to be included in search results, replacing any previously set.
withConnectionManagerTimeoutMs(int) - Method in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactoryBuilder: Sets the connection manager timeout in milliseconds.
withConnectionTimeoutMs(int) - Method in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactoryBuilder: Set the time in milliseconds to wait for a connection to be established before aborting the request.
withException(RuntimeException) - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.ServiceResponseBuilder: Set the exception thrown based on service errors in the response or an error parsing the JSON.
withExpiredAuthTokenStrategy(ExpiredAuthTokenStrategy) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlLegacyApiSessionFactory: Set the strategy to use when credentials authentication is configured and the current auth token expires.
withFilters(Map<String, String>) - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceSearchRequestBuilder: Set the column value filters to be applied to the search, replacing any previous filters set on this builder.
withFirstResult(Integer) - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceSearchRequestBuilder: Sets the first result to return, allowing paging through large result sets.
withGson(Gson) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClientFactory: Provide a custom GSON instance for serialising JSON request bodies and deserialising JSON responses.
withHeaders(Map<String, String>) - Method in class uk.co.visalia.brightpearl.apiclient.http.RequestBuilder: Sets the map of unencoded headers to be added to the request.
withHeaders(Map<String, String>) - Method in class uk.co.visalia.brightpearl.apiclient.http.ResponseBuilder: Set the response headers received.
withMaxConnections(int) - Method in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactoryBuilder: Set the maximum total connections allowed across all routes.
withMaxConnectionsPerRoute(int) - Method in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactoryBuilder: Set the maximum connections allowed per route.
withMethod(Method) - Method in class uk.co.visalia.brightpearl.apiclient.http.RequestBuilder: Sets the HTTP method of the request.
withOnFailOption(OnFailOption) - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.MultiRequestBuilder: Set the on fail option (STOP or CONTINUE) for the request, defining whether remaining requests should still be executed when one fails.
withPage(Integer, Integer) - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceSearchRequestBuilder: Set paging parameters in one call.
withPageSize(Integer) - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceSearchRequestBuilder: Sets the number of results to return per page, allowing paging through large result sets.
withParameters(Map<String, String>) - Method in class uk.co.visalia.brightpearl.apiclient.http.RequestBuilder: Sets the map of unencoded querystring parameters to be added to the URL.
withParams(Map<String, String>) - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceReadRequestSetBuilder: Add querystring parameters to every request, replacing any previously set.
withProcessingMode(ProcessingMode) - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.MultiRequestBuilder: Set the processing mode option (SEQUENTIAL or PARALLEL) for the request, which defines whether requests should be executed in serial or in parallel by the Brightpearl multimessage API.
withRateLimiter(RateLimiter) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlApiClientFactory: Set the RateLimiter implementation to be used for monitoring and limiting request throughput.
withRequests(List<ServiceWriteRequest>) - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.MultiRequestBuilder: Set the requests to be added to the multimessage batch, replacing any previously set.
withResponse(T) - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.ServiceResponseBuilder: Sets the entity received in the response element of the JSON response body.
withRuid(String) - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.ServiceResponseBuilder: Set the unique ID of the request this is a response to.
withServiceResponseMap(Map<String, ServiceResponse>) - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.MultiResponseBuilder: Set the results of individual executed requests as a map of request unique ID to response object.
withSocketTimeoutMs(int) - Method in class uk.co.visalia.brightpearl.apiclient.http.httpclient4.HttpClient4ClientFactoryBuilder: Maximum time of inactivity to allow between two consecutive data packets from the server before aborting the request.
withSorts(Map<String, SortDirection>) - Method in class uk.co.visalia.brightpearl.apiclient.request.ServiceSearchRequestBuilder: Set the sort columns and directions, replacing any previously added.
withStatus(int) - Method in class uk.co.visalia.brightpearl.apiclient.http.ResponseBuilder: Set the HTTP response status.
withStatus(int) - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.MultiResponseBuilder: Set the HTTP response code for the multimessage request.
withStatus(int) - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.ServiceResponseBuilder: Set the HTTP status code returned for this individual response.
withUnprocessedRequestIds(List<String>) - Method in class uk.co.visalia.brightpearl.apiclient.multimessage.MultiResponseBuilder: Set the list of unique request IDs that were not executed due to a failured.
withUrl(String) - Method in class uk.co.visalia.brightpearl.apiclient.http.RequestBuilder: Sets the full URL of the resource.
withUserCredentials(UserCredentials) - Method in class uk.co.visalia.brightpearl.apiclient.BrightpearlLegacyApiSessionFactory: Set the credentials of an API-enabled user account associated with the customer account.
write(JsonWriter, Calendar) - Method in class uk.co.visalia.brightpearl.apiclient.client.adaptors.CalendarAdaptor
write(JsonWriter, DateTime) - Method in class uk.co.visalia.brightpearl.apiclient.client.adaptors.DateTimeAdaptor

A B C D E F G H I J L M N O P R S T U V W