Package api

Class FeeProfilesApi

java.lang.Object

api.FeeProfilesApi

public class FeeProfilesApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	FeeProfilesApi.APIlistFeeProfilesRequest

Constructor Summary

Constructors

Constructor	Description
FeeProfilesApi()
FeeProfilesApi(FinixClient finixClient)

Method Summary

Modifier and Type	Method	Description
FeeProfile	create(CreateFeeProfileRequest createFeeProfileRequest)	Create a Fee Profile Create a `fee_profile`.
okhttp3.Call	createFeeProfileAsync(CreateFeeProfileRequest createFeeProfileRequest, ApiCallback<FeeProfile> _callback)	Create a Fee Profile (asynchronously) Create a `fee_profile`.
okhttp3.Call	createFeeProfileCall(CreateFeeProfileRequest createFeeProfileRequest, ApiCallback _callback)	Build call for createFeeProfile
ApiResponse<FeeProfile>	createFeeProfileWithHttpInfo(CreateFeeProfileRequest createFeeProfileRequest)	Create a Fee Profile Create a `fee_profile`.
FeeProfile	get(String feeProfileId)	Fetch a Fee Profile Get a `fee_profile`.
String	getCustomBaseUrl()
okhttp3.Call	getFeeProfileAsync(String feeProfileId, ApiCallback<FeeProfile> _callback)	Fetch a Fee Profile (asynchronously) Get a `fee_profile`.
okhttp3.Call	getFeeProfileCall(String feeProfileId, ApiCallback _callback)	Build call for getFeeProfile
ApiResponse<FeeProfile>	getFeeProfileWithHttpInfo(String feeProfileId)	Fetch a Fee Profile Get a `fee_profile`.
FinixClient	getFinixClient()
int	getHostIndex()
FinixList	list(ListFeeProfilesQueryParams listFeeProfilesQueryParams)	List Fee Profiles List all `Fee Profiles`.
void	setCustomBaseUrl(String customBaseUrl)
void	setFinixClient(FinixClient finixClient)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

FeeProfilesApi

public FeeProfilesApi()

FeeProfilesApi

public FeeProfilesApi(FinixClient finixClient)

Method Detail

getFinixClient

public FinixClient getFinixClient()

setFinixClient

public void setFinixClient(FinixClient finixClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createFeeProfileCall

public okhttp3.Call createFeeProfileCall(CreateFeeProfileRequest createFeeProfileRequest,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for createFeeProfile

Parameters:

createFeeProfileRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Fee profile	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

create

public FeeProfile create(CreateFeeProfileRequest createFeeProfileRequest)
                  throws ApiException

Create a Fee Profile Create a `fee_profile`.

Parameters:

createFeeProfileRequest - (optional)

Returns:

FeeProfile

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
201	Fee profile	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

createFeeProfileWithHttpInfo

public ApiResponse<FeeProfile> createFeeProfileWithHttpInfo(CreateFeeProfileRequest createFeeProfileRequest)
                                                     throws ApiException

Create a Fee Profile Create a `fee_profile`.

Parameters:

createFeeProfileRequest - (optional)

Returns:

ApiResponse<FeeProfile>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
201	Fee profile	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

createFeeProfileAsync

public okhttp3.Call createFeeProfileAsync(CreateFeeProfileRequest createFeeProfileRequest,
                                          ApiCallback<FeeProfile> _callback)
                                   throws ApiException

Create a Fee Profile (asynchronously) Create a `fee_profile`.

Parameters:

createFeeProfileRequest - (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

Http Response Details:

Status Code	Description	Response Headers
201	Fee profile	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

getFeeProfileCall

public okhttp3.Call getFeeProfileCall(String feeProfileId,
                                      ApiCallback _callback)
                               throws ApiException

Build call for getFeeProfile

Parameters:

feeProfileId - The ID of the `fee_profile`. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Fee profile	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

get

public FeeProfile get(String feeProfileId)
               throws ApiException

Fetch a Fee Profile Get a `fee_profile`.

Parameters:

feeProfileId - The ID of the `fee_profile`. (required)

Returns:

FeeProfile

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Fee profile	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getFeeProfileWithHttpInfo

public ApiResponse<FeeProfile> getFeeProfileWithHttpInfo(String feeProfileId)
                                                  throws ApiException

Fetch a Fee Profile Get a `fee_profile`.

Parameters:

feeProfileId - The ID of the `fee_profile`. (required)

Returns:

ApiResponse<FeeProfile>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Fee profile	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getFeeProfileAsync

public okhttp3.Call getFeeProfileAsync(String feeProfileId,
                                       ApiCallback<FeeProfile> _callback)
                                throws ApiException

Fetch a Fee Profile (asynchronously) Get a `fee_profile`.

Parameters:

feeProfileId - The ID of the `fee_profile`. (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

Http Response Details:

Status Code	Description	Response Headers
200	Fee profile	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

list

public FinixList list(ListFeeProfilesQueryParams listFeeProfilesQueryParams)
               throws ApiException

List Fee Profiles List all `Fee Profiles`.

Returns:

APIlistFeeProfilesRequest

Throws:

ApiException

Http Response Details:

Status Code	Description	Response Headers
200	List of fee profiles	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -