io.swagger.client.api

Class SecuritiesApi

java.lang.Object

io.swagger.client.api.SecuritiesApi

public class SecuritiesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SecuritiesApi()
SecuritiesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
PageableSecurityList	getAndSearchAllSecurities(List<Long> ids, String search, List<Long> accountIds, Integer page, Integer perPage, List<String> order) Get and search all securities Get securities of the user that is authorized by the access_token.
com.squareup.okhttp.Call	getAndSearchAllSecuritiesAsync(List<Long> ids, String search, List<Long> accountIds, Integer page, Integer perPage, List<String> order, ApiCallback<PageableSecurityList> callback) Get and search all securities (asynchronously) Get securities of the user that is authorized by the access_token.
com.squareup.okhttp.Call	getAndSearchAllSecuritiesCall(List<Long> ids, String search, List<Long> accountIds, Integer page, Integer perPage, List<String> order, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAndSearchAllSecurities
ApiResponse<PageableSecurityList>	getAndSearchAllSecuritiesWithHttpInfo(List<Long> ids, String search, List<Long> accountIds, Integer page, Integer perPage, List<String> order) Get and search all securities Get securities of the user that is authorized by the access_token.
ApiClient	getApiClient()
SecurityList	getMultipleSecurities(List<Long> ids) Deprecated.
com.squareup.okhttp.Call	getMultipleSecuritiesAsync(List<Long> ids, ApiCallback<SecurityList> callback) Deprecated.
com.squareup.okhttp.Call	getMultipleSecuritiesCall(List<Long> ids, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Deprecated.
ApiResponse<SecurityList>	getMultipleSecuritiesWithHttpInfo(List<Long> ids) Deprecated.
Security	getSecurity(Long id) Get a security Get a single security for a specific user.
com.squareup.okhttp.Call	getSecurityAsync(Long id, ApiCallback<Security> callback) Get a security (asynchronously) Get a single security for a specific user.
com.squareup.okhttp.Call	getSecurityCall(Long id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getSecurity
ApiResponse<Security>	getSecurityWithHttpInfo(Long id) Get a security Get a single security for a specific user.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecuritiesApi

public SecuritiesApi()

SecuritiesApi

public SecuritiesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getAndSearchAllSecuritiesCall

public com.squareup.okhttp.Call getAndSearchAllSecuritiesCall(List<Long> ids,
                                                              String search,
                                                              List<Long> accountIds,
                                                              Integer page,
                                                              Integer perPage,
                                                              List<String> order,
                                                              ProgressResponseBody.ProgressListener progressListener,
                                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                       throws ApiException

Build call for getAndSearchAllSecurities

Parameters:

ids - A comma-separated list of security identifiers. If specified, then only securities whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (optional)

search - If specified, then only those securities will be contained in the result whose 'name', 'isin' or 'wkn' contains the given search string (the matching works case-insensitive). If no securities contain the search string in any of these fields, then the result will be an empty list. NOTE: If the given search string consists of several terms (separated by whitespace), then ALL of these terms must be contained in the searched fields in order for a security to get included into the result. (optional)

accountIds - Comma-separated list of identifiers of accounts (optional)

page - Result page that you want to retrieve. (optional, default to 1)

perPage - Maximum number of records per page. Can be at most 500. NOTE: Due to its validation and visualization, the swagger frontend might show very low performance, or even crashes, when a service responds with a lot of data. It is recommended to use a HTTP client like Postman or DHC instead of our swagger frontend for service calls with large page sizes. (optional, default to 20)

order - Determines the order of the results. You can order the results by next fields: 'id', 'name', 'isin', 'wkn', 'quote', 'quantityNominal', 'marketValue' and 'entryQuote'. The default order for all services is 'id,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. The general format is: 'property[,asc|desc]', with 'asc' being the default value. Please note that ordering by multiple fields is not supported in our swagger frontend, but you can test this feature with any HTTP tool of your choice (e.g. postman or DHC). (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAndSearchAllSecurities

public PageableSecurityList getAndSearchAllSecurities(List<Long> ids,
                                                      String search,
                                                      List<Long> accountIds,
                                                      Integer page,
                                                      Integer perPage,
                                                      List<String> order)
                                               throws ApiException

Get and search all securities Get securities of the user that is authorized by the access_token. Must pass the user's access_token. You can set optional search criteria to get only those securities that you are interested in. If you do not specify any search criteria, then this service functions as a 'get all' service.<p>Note: Whenever a security account is being updated, its security positions will be internally re-created, meaning that the identifier of a security position might change over time.</p>

Parameters:

ids - A comma-separated list of security identifiers. If specified, then only securities whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (optional)

search - If specified, then only those securities will be contained in the result whose 'name', 'isin' or 'wkn' contains the given search string (the matching works case-insensitive). If no securities contain the search string in any of these fields, then the result will be an empty list. NOTE: If the given search string consists of several terms (separated by whitespace), then ALL of these terms must be contained in the searched fields in order for a security to get included into the result. (optional)

accountIds - Comma-separated list of identifiers of accounts (optional)

page - Result page that you want to retrieve. (optional, default to 1)

perPage - Maximum number of records per page. Can be at most 500. NOTE: Due to its validation and visualization, the swagger frontend might show very low performance, or even crashes, when a service responds with a lot of data. It is recommended to use a HTTP client like Postman or DHC instead of our swagger frontend for service calls with large page sizes. (optional, default to 20)

order - Determines the order of the results. You can order the results by next fields: 'id', 'name', 'isin', 'wkn', 'quote', 'quantityNominal', 'marketValue' and 'entryQuote'. The default order for all services is 'id,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. The general format is: 'property[,asc|desc]', with 'asc' being the default value. Please note that ordering by multiple fields is not supported in our swagger frontend, but you can test this feature with any HTTP tool of your choice (e.g. postman or DHC). (optional)

Returns:

PageableSecurityList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAndSearchAllSecuritiesWithHttpInfo

public ApiResponse<PageableSecurityList> getAndSearchAllSecuritiesWithHttpInfo(List<Long> ids,
                                                                               String search,
                                                                               List<Long> accountIds,
                                                                               Integer page,
                                                                               Integer perPage,
                                                                               List<String> order)
                                                                        throws ApiException

Get and search all securities Get securities of the user that is authorized by the access_token. Must pass the user's access_token. You can set optional search criteria to get only those securities that you are interested in. If you do not specify any search criteria, then this service functions as a 'get all' service.<p>Note: Whenever a security account is being updated, its security positions will be internally re-created, meaning that the identifier of a security position might change over time.</p>

Parameters:

ids - A comma-separated list of security identifiers. If specified, then only securities whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (optional)

search - If specified, then only those securities will be contained in the result whose 'name', 'isin' or 'wkn' contains the given search string (the matching works case-insensitive). If no securities contain the search string in any of these fields, then the result will be an empty list. NOTE: If the given search string consists of several terms (separated by whitespace), then ALL of these terms must be contained in the searched fields in order for a security to get included into the result. (optional)

accountIds - Comma-separated list of identifiers of accounts (optional)

page - Result page that you want to retrieve. (optional, default to 1)

perPage - Maximum number of records per page. Can be at most 500. NOTE: Due to its validation and visualization, the swagger frontend might show very low performance, or even crashes, when a service responds with a lot of data. It is recommended to use a HTTP client like Postman or DHC instead of our swagger frontend for service calls with large page sizes. (optional, default to 20)

order - Determines the order of the results. You can order the results by next fields: 'id', 'name', 'isin', 'wkn', 'quote', 'quantityNominal', 'marketValue' and 'entryQuote'. The default order for all services is 'id,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. The general format is: 'property[,asc|desc]', with 'asc' being the default value. Please note that ordering by multiple fields is not supported in our swagger frontend, but you can test this feature with any HTTP tool of your choice (e.g. postman or DHC). (optional)

Returns:

ApiResponse<PageableSecurityList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAndSearchAllSecuritiesAsync

public com.squareup.okhttp.Call getAndSearchAllSecuritiesAsync(List<Long> ids,
                                                               String search,
                                                               List<Long> accountIds,
                                                               Integer page,
                                                               Integer perPage,
                                                               List<String> order,
                                                               ApiCallback<PageableSecurityList> callback)
                                                        throws ApiException

Get and search all securities (asynchronously) Get securities of the user that is authorized by the access_token. Must pass the user's access_token. You can set optional search criteria to get only those securities that you are interested in. If you do not specify any search criteria, then this service functions as a 'get all' service.<p>Note: Whenever a security account is being updated, its security positions will be internally re-created, meaning that the identifier of a security position might change over time.</p>

Parameters:

ids - A comma-separated list of security identifiers. If specified, then only securities whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (optional)

search - If specified, then only those securities will be contained in the result whose 'name', 'isin' or 'wkn' contains the given search string (the matching works case-insensitive). If no securities contain the search string in any of these fields, then the result will be an empty list. NOTE: If the given search string consists of several terms (separated by whitespace), then ALL of these terms must be contained in the searched fields in order for a security to get included into the result. (optional)

accountIds - Comma-separated list of identifiers of accounts (optional)

page - Result page that you want to retrieve. (optional, default to 1)

perPage - Maximum number of records per page. Can be at most 500. NOTE: Due to its validation and visualization, the swagger frontend might show very low performance, or even crashes, when a service responds with a lot of data. It is recommended to use a HTTP client like Postman or DHC instead of our swagger frontend for service calls with large page sizes. (optional, default to 20)

order - Determines the order of the results. You can order the results by next fields: 'id', 'name', 'isin', 'wkn', 'quote', 'quantityNominal', 'marketValue' and 'entryQuote'. The default order for all services is 'id,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. The general format is: 'property[,asc|desc]', with 'asc' being the default value. Please note that ordering by multiple fields is not supported in our swagger frontend, but you can test this feature with any HTTP tool of your choice (e.g. postman or DHC). (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getMultipleSecuritiesCall

@Deprecated
public com.squareup.okhttp.Call getMultipleSecuritiesCall(List<Long> ids,
                                                                      ProgressResponseBody.ProgressListener progressListener,
                                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                               throws ApiException

Deprecated.

Build call for getMultipleSecurities

Parameters:

ids - Comma-separated list of identifiers of requested securities (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getMultipleSecurities

@Deprecated
public SecurityList getMultipleSecurities(List<Long> ids)
                                               throws ApiException

Deprecated.

Get multiple securities Get a list of multiple securities of the user that is authorized by the access_token. Must pass the securities' identifiers and the user's access_token. Securities whose identifiers do not exist or do not relate to the authorized user will not be contained in the result (If this applies to all of the given identifiers, then the result will be an empty list). <p>Note: Whenever a security account is being updated, its security positions will be internally re-created, meaning that the identifier of a security position might change over time.</p><p>WARNING: This service is deprecated and will be removed at some point. If you want to get multiple securities, please instead use the service 'Get and search all securities' and pass a comma-separated list of identifiers as a parameter 'ids'.</p>

Parameters:

ids - Comma-separated list of identifiers of requested securities (required)

Returns:

SecurityList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getMultipleSecuritiesWithHttpInfo

@Deprecated
public ApiResponse<SecurityList> getMultipleSecuritiesWithHttpInfo(List<Long> ids)
                                                                        throws ApiException

Deprecated.

Get multiple securities Get a list of multiple securities of the user that is authorized by the access_token. Must pass the securities' identifiers and the user's access_token. Securities whose identifiers do not exist or do not relate to the authorized user will not be contained in the result (If this applies to all of the given identifiers, then the result will be an empty list). <p>Note: Whenever a security account is being updated, its security positions will be internally re-created, meaning that the identifier of a security position might change over time.</p><p>WARNING: This service is deprecated and will be removed at some point. If you want to get multiple securities, please instead use the service 'Get and search all securities' and pass a comma-separated list of identifiers as a parameter 'ids'.</p>

Parameters:

ids - Comma-separated list of identifiers of requested securities (required)

Returns:

ApiResponse<SecurityList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getMultipleSecuritiesAsync

@Deprecated
public com.squareup.okhttp.Call getMultipleSecuritiesAsync(List<Long> ids,
                                                                       ApiCallback<SecurityList> callback)
                                                                throws ApiException

Deprecated.

Get multiple securities (asynchronously) Get a list of multiple securities of the user that is authorized by the access_token. Must pass the securities' identifiers and the user's access_token. Securities whose identifiers do not exist or do not relate to the authorized user will not be contained in the result (If this applies to all of the given identifiers, then the result will be an empty list). <p>Note: Whenever a security account is being updated, its security positions will be internally re-created, meaning that the identifier of a security position might change over time.</p><p>WARNING: This service is deprecated and will be removed at some point. If you want to get multiple securities, please instead use the service 'Get and search all securities' and pass a comma-separated list of identifiers as a parameter 'ids'.</p>

Parameters:

ids - Comma-separated list of identifiers of requested securities (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getSecurityCall

public com.squareup.okhttp.Call getSecurityCall(Long id,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for getSecurity

Parameters:

id - Security identifier (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSecurity

public Security getSecurity(Long id)
                     throws ApiException

Get a security Get a single security for a specific user. Must pass the security's identifier and the user's access_token. <p>Note: Whenever a security account is being updated, its security positions will be internally re-created, meaning that the identifier of a security position might change over time.</p>

Parameters:

id - Security identifier (required)

Returns:

Security

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getSecurityWithHttpInfo

public ApiResponse<Security> getSecurityWithHttpInfo(Long id)
                                              throws ApiException

Get a security Get a single security for a specific user. Must pass the security's identifier and the user's access_token. <p>Note: Whenever a security account is being updated, its security positions will be internally re-created, meaning that the identifier of a security position might change over time.</p>

Parameters:

id - Security identifier (required)

Returns:

ApiResponse<Security>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getSecurityAsync

public com.squareup.okhttp.Call getSecurityAsync(Long id,
                                                 ApiCallback<Security> callback)
                                          throws ApiException

Get a security (asynchronously) Get a single security for a specific user. Must pass the security's identifier and the user's access_token. <p>Note: Whenever a security account is being updated, its security positions will be internally re-created, meaning that the identifier of a security position might change over time.</p>

Parameters:

id - Security identifier (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object