Package api

Class DefaultApi

java.lang.Object

api.DefaultApi

public class DefaultApi
extends Object

Constructor Summary

Constructors

Constructor	Description
DefaultApi()
DefaultApi(FinixClient finixClient)

Method Summary

Modifier and Type	Method	Description
String	getCustomBaseUrl()
FinixClient	getFinixClient()
int	getHostIndex()
OnboardingForm	getOnboardingForm(String onboardingFormId)	Fetch an Onboarding Form Retrieve the details of an `onboarding_form`.
okhttp3.Call	getOnboardingFormAsync(String onboardingFormId, ApiCallback<OnboardingForm> _callback)	Fetch an Onboarding Form (asynchronously) Retrieve the details of an `onboarding_form`.
okhttp3.Call	getOnboardingFormCall(String onboardingFormId, ApiCallback _callback)	Build call for getOnboardingForm
ApiResponse<OnboardingForm>	getOnboardingFormWithHttpInfo(String onboardingFormId)	Fetch an Onboarding Form Retrieve the details of an `onboarding_form`.
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

DefaultApi

public DefaultApi()

DefaultApi

public DefaultApi(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)

getOnboardingFormCall

public okhttp3.Call getOnboardingFormCall(String onboardingFormId,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for getOnboardingForm

Parameters:

onboardingFormId - The id of the `onboarding_form`. (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	A single `onboarding_from` objext.	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -

getOnboardingForm

public OnboardingForm getOnboardingForm(String onboardingFormId)
                                 throws ApiException

Fetch an Onboarding Form Retrieve the details of an `onboarding_form`.

Parameters:

onboardingFormId - The id of the `onboarding_form`. (required)

Returns:

OnboardingForm

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	A single `onboarding_from` objext.	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -

getOnboardingFormWithHttpInfo

public ApiResponse<OnboardingForm> getOnboardingFormWithHttpInfo(String onboardingFormId)
                                                          throws ApiException

Fetch an Onboarding Form Retrieve the details of an `onboarding_form`.

Parameters:

onboardingFormId - The id of the `onboarding_form`. (required)

Returns:

ApiResponse<OnboardingForm>

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	A single `onboarding_from` objext.	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -

getOnboardingFormAsync

public okhttp3.Call getOnboardingFormAsync(String onboardingFormId,
                                           ApiCallback<OnboardingForm> _callback)
                                    throws ApiException

Fetch an Onboarding Form (asynchronously) Retrieve the details of an `onboarding_form`.

Parameters:

onboardingFormId - The id of the `onboarding_form`. (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	A single `onboarding_from` objext.	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -