Index

A B C D E F G I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

AFTER_X_DAYS - Enum constant in enum class dev.array21.espocrm.types.FilterType

AND - Enum constant in enum class dev.array21.espocrm.types.FilterType

apiKey - Variable in class dev.array21.espocrm.client.EspoApiClient

ARRAY_ALL_OF - Enum constant in enum class dev.array21.espocrm.types.FilterType

ARRAY_ANY_OF - Enum constant in enum class dev.array21.espocrm.types.FilterType

ARRAY_IS_EMPTY - Enum constant in enum class dev.array21.espocrm.types.FilterType

ARRAY_IS_NOT_EMPTY - Enum constant in enum class dev.array21.espocrm.types.FilterType

ARRAY_NONE_OF - Enum constant in enum class dev.array21.espocrm.types.FilterType

ASC - Enum constant in enum class dev.array21.espocrm.types.Order

B

BETWEEN - Enum constant in enum class dev.array21.espocrm.types.FilterType

build() - Method in class dev.array21.espocrm.client.ClientBuilder

Create an instance of EspoApiClient from this builder.

C

ClientBuilder - Class in dev.array21.espocrm.client

Builder for the EspoApiClient

ClientBuilder() - Constructor for class dev.array21.espocrm.client.ClientBuilder

CONTAINS - Enum constant in enum class dev.array21.espocrm.types.FilterType

CURRENT_FISCAL_QUARTER - Enum constant in enum class dev.array21.espocrm.types.FilterType

CURRENT_FISCAL_YEAR - Enum constant in enum class dev.array21.espocrm.types.FilterType

CURRENT_MONTH - Enum constant in enum class dev.array21.espocrm.types.FilterType

CURRENT_QUARTER - Enum constant in enum class dev.array21.espocrm.types.FilterType

CURRENT_YEAR - Enum constant in enum class dev.array21.espocrm.types.FilterType

D

DELETE - Enum constant in enum class dev.array21.espocrm.types.Method

DESC - Enum constant in enum class dev.array21.espocrm.types.Order

dev.array21.espocrm - package dev.array21.espocrm

dev.array21.espocrm.client - package dev.array21.espocrm.client

dev.array21.espocrm.types - package dev.array21.espocrm.types

E

ENDS_WITH - Enum constant in enum class dev.array21.espocrm.types.FilterType

EQUALS - Enum constant in enum class dev.array21.espocrm.types.FilterType

EspoApiClient - Class in dev.array21.espocrm.client

A client for the EspoCRM API

EspoApiClient() - Constructor for class dev.array21.espocrm.client.EspoApiClient

F

FilterType - Enum Class in dev.array21.espocrm.types

The FilterType to use in a Where filter.
Refer to the EspoCRM documentation for more information

FUTURE - Enum constant in enum class dev.array21.espocrm.types.FilterType

G

GET - Enum constant in enum class dev.array21.espocrm.types.Method

getAttribute() - Method in class dev.array21.espocrm.types.Where

The attribute to apply the filter to

getBoolFilterList() - Method in class dev.array21.espocrm.types.Params

Bool filters.

getFilterType() - Method in class dev.array21.espocrm.types.Where

The FilterType to use

getMaxSize() - Method in class dev.array21.espocrm.types.Params

How much records to return.

getOffset() - Method in class dev.array21.espocrm.types.Params

An offset for pagination.

getOrder() - Method in class dev.array21.espocrm.types.Params

A direction of order: 'desc' or 'asc'.

getOrderBy() - Method in class dev.array21.espocrm.types.Params

An attribute to order by.

getPrimaryFilter() - Method in class dev.array21.espocrm.types.Params

A primary filter.

getSelect() - Method in class dev.array21.espocrm.types.Params

What record attributes to return.

getStatusCode() - Method in exception class dev.array21.espocrm.client.RequestException

The HTTP status code returned by EspoCRM

getValue() - Method in class dev.array21.espocrm.types.Where

The value Field.

getWhere() - Method in class dev.array21.espocrm.types.Params

Search criteria.

GREATER_THAN - Enum constant in enum class dev.array21.espocrm.types.FilterType

GREATER_THAN_OR_EQUALS - Enum constant in enum class dev.array21.espocrm.types.FilterType

I

IN - Enum constant in enum class dev.array21.espocrm.types.FilterType

IS_FALSE - Enum constant in enum class dev.array21.espocrm.types.FilterType

IS_LINKED - Enum constant in enum class dev.array21.espocrm.types.FilterType

IS_NOT_LINKED - Enum constant in enum class dev.array21.espocrm.types.FilterType

IS_NOT_NULL - Enum constant in enum class dev.array21.espocrm.types.FilterType

IS_NULL - Enum constant in enum class dev.array21.espocrm.types.FilterType

IS_TRUE - Enum constant in enum class dev.array21.espocrm.types.FilterType

L

LAST_FISCAL_QUARTER - Enum constant in enum class dev.array21.espocrm.types.FilterType

LAST_FISCAL_YEAR - Enum constant in enum class dev.array21.espocrm.types.FilterType

LAST_MONTH - Enum constant in enum class dev.array21.espocrm.types.FilterType

LAST_QUARTER - Enum constant in enum class dev.array21.espocrm.types.FilterType

LAST_SEVEN_DAYS - Enum constant in enum class dev.array21.espocrm.types.FilterType

LAST_X_DAYS - Enum constant in enum class dev.array21.espocrm.types.FilterType

LAST_YEAR - Enum constant in enum class dev.array21.espocrm.types.FilterType

LESS_THAN - Enum constant in enum class dev.array21.espocrm.types.FilterType

LESS_THAN_OR_EQUALS - Enum constant in enum class dev.array21.espocrm.types.FilterType

LIKE - Enum constant in enum class dev.array21.espocrm.types.FilterType

LINKED_WITH - Enum constant in enum class dev.array21.espocrm.types.FilterType

M

Method - Enum Class in dev.array21.espocrm.types

The HTTP request method to use

N

NEXT_X_DAYS - Enum constant in enum class dev.array21.espocrm.types.FilterType

NOT_CONTAINS - Enum constant in enum class dev.array21.espocrm.types.FilterType

NOT_EQUALS - Enum constant in enum class dev.array21.espocrm.types.FilterType

NOT_IN - Enum constant in enum class dev.array21.espocrm.types.FilterType

NOT_LIKE - Enum constant in enum class dev.array21.espocrm.types.FilterType

NOT_LINKED_WIDTH - Enum constant in enum class dev.array21.espocrm.types.FilterType

O

OLDER_THAN_X_DAYS - Enum constant in enum class dev.array21.espocrm.types.FilterType

OR - Enum constant in enum class dev.array21.espocrm.types.FilterType

Order - Enum Class in dev.array21.espocrm.types

The direction to order by, either ascending or descending.

P

Params - Class in dev.array21.espocrm.types

Query parameters for a GET request to EspoCRM
Refer to the EspoCRM documentation for more information

Params() - Constructor for class dev.array21.espocrm.types.Params

password - Variable in class dev.array21.espocrm.client.EspoApiClient

PAST - Enum constant in enum class dev.array21.espocrm.types.FilterType

POST - Enum constant in enum class dev.array21.espocrm.types.Method

PUT - Enum constant in enum class dev.array21.espocrm.types.Method

R

request(Method, String, T) - Method in class dev.array21.espocrm.client.EspoApiClient

Send a POST, PUT or DELETE request to EspoCRM

RequestException - Exception Class in dev.array21.espocrm.client

This exception is thrown when we receive a non-200 HTTP status code from EspoCRM

RequestException(int, String) - Constructor for exception class dev.array21.espocrm.client.RequestException

requestGet(String, Params) - Method in class dev.array21.espocrm.client.EspoApiClient

Send a GET request to EspoCRM

S

secretKey - Variable in class dev.array21.espocrm.client.EspoApiClient

serialize(Params) - Static method in class dev.array21.espocrm.Serializer

Serialize a Params object into a query String

Serializer - Class in dev.array21.espocrm

Serialize a Params object into a query String.

Serializer() - Constructor for class dev.array21.espocrm.Serializer

setApiKey(String) - Method in class dev.array21.espocrm.client.ClientBuilder

Set the API key to use for authentication.

setAttribute(String) - Method in class dev.array21.espocrm.types.Where

The attribute to apply the filter to.

setBoolFilterList(String[]) - Method in class dev.array21.espocrm.types.Params

Bool filters.

setBoolFilterList(List<String>) - Method in class dev.array21.espocrm.types.Params

Bool filters.

setFilterType(FilterType) - Method in class dev.array21.espocrm.types.Where

The FilterType to use.

setHost(String) - Method in class dev.array21.espocrm.client.ClientBuilder

Set the EspoCRM URL

setMaxSize(long) - Method in class dev.array21.espocrm.types.Params

How much records to return.

setOffset(long) - Method in class dev.array21.espocrm.types.Params

An offset for pagination.

setOrder(Order) - Method in class dev.array21.espocrm.types.Params

A direction of order: 'desc' or 'asc'.

setOrderBy(String) - Method in class dev.array21.espocrm.types.Params

An attribute to order by.

setPassword(String) - Method in class dev.array21.espocrm.client.ClientBuilder

Set the password to use for authentication.

setPrimaryFilter(String) - Method in class dev.array21.espocrm.types.Params

A primary filter.

setSecretKey(String) - Method in class dev.array21.espocrm.client.ClientBuilder

Set the secret key to use for authentication.

setSelect(String) - Method in class dev.array21.espocrm.types.Params

What record attributes to return.

setUsername(String) - Method in class dev.array21.espocrm.client.ClientBuilder

Set the username to use for authentication.

setValueString(String) - Method in class dev.array21.espocrm.types.Where

Set the Value field to a String

setValueStringArray(String[]) - Method in class dev.array21.espocrm.types.Where

Set the Value field to a String[]

setValueStringList(List<String>) - Method in class dev.array21.espocrm.types.Where

Set the Value field to a List, this is converted to a String[]

setWhere(Where[]) - Method in class dev.array21.espocrm.types.Params

Search criteria.

setWhere(List<Where>) - Method in class dev.array21.espocrm.types.Params

Search criteria.

STARTS_WITH - Enum constant in enum class dev.array21.espocrm.types.FilterType

T

TODAY - Enum constant in enum class dev.array21.espocrm.types.FilterType

toString() - Method in enum class dev.array21.espocrm.types.FilterType

Returns the String value of this Enum in lowerCamelCase as required by the EspoCRM API

toString() - Method in enum class dev.array21.espocrm.types.Order

Returns the String value of this Enum in lowerCamelCase as required by the EspoCRM API

U

url - Variable in class dev.array21.espocrm.client.EspoApiClient

username - Variable in class dev.array21.espocrm.client.EspoApiClient

V

valueOf(String) - Static method in enum class dev.array21.espocrm.types.FilterType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class dev.array21.espocrm.types.Method

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class dev.array21.espocrm.types.Order

Returns the enum constant of this class with the specified name.

values() - Static method in enum class dev.array21.espocrm.types.FilterType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class dev.array21.espocrm.types.Method

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class dev.array21.espocrm.types.Order

Returns an array containing the constants of this enum class, in the order they are declared.

W

Where - Class in dev.array21.espocrm.types

Where parameter is an array if items, that can contain nested items.

Where(FilterType, String) - Constructor for class dev.array21.espocrm.types.Where

Create a new Where filter

A B C D E F G I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form