AccountsApi.md

AccountsApi

All URIs are relative to https://api.flipdish.co

Method	HTTP request	Description
answerSignUpQuestion	POST /api/v1.0/accounts/signupstep/{signupStepAction}/answer
changePassword	PUT /api/v1.0/accounts/password
changePasswordWithPin	PUT /api/v1.0/accounts/password/pin
createAccount	POST /api/v1.0/accounts
createBasicAccount	POST /api/v1.0/accounts/basic-account
getAccountDetails	GET /api/v1.0/accounts
getLocalisedTimeZones	GET /api/v1.0/accounts/timezones
login	POST /api/v1.0/accounts/login
loginSso	POST /api/v1.0/accounts/login/sso
loginWithPin	POST /api/v1.0/accounts/login/pin
logout	POST /api/v1.0/accounts/logout
passwordResetWithToken	POST /api/v1.0/accounts/password
recaptchaValidate	POST /api/v1.0/accounts/recaptcha
requestLoginPin	POST /api/v1.0/accounts/pin
requestPasswordReset	POST /api/v1.0/accounts/passwordreset
sendPinForPasswordReset	POST /api/v1.0/accounts/password/resetpin
skipSignupStep	POST /api/v1.0/accounts/signupstep/{signupStepAction}/skip
updateAccount	PUT /api/v1.0/accounts

answerSignUpQuestion

answerSignUpQuestion(signupStepAction, answerId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.AccountsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

AccountsApi apiInstance = new AccountsApi();
String signupStepAction = "signupStepAction_example"; // String | 
Integer answerId = 56; // Integer | 
try {
    apiInstance.answerSignUpQuestion(signupStepAction, answerId);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#answerSignUpQuestion");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
signupStepAction	String		[enum: Question, StoreLocation, PaymentSubscription, StoreName]
answerId	Integer

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

changePassword

changePassword(changePasswordModel)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.AccountsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

AccountsApi apiInstance = new AccountsApi();
ChangePasswordModel changePasswordModel = new ChangePasswordModel(); // ChangePasswordModel | 
try {
    apiInstance.changePassword(changePasswordModel);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#changePassword");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
changePasswordModel	ChangePasswordModel

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

changePasswordWithPin

changePasswordWithPin(changePasswordModel)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.AccountsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

AccountsApi apiInstance = new AccountsApi();
SetPasswordWithPinModel changePasswordModel = new SetPasswordWithPinModel(); // SetPasswordWithPinModel | 
try {
    apiInstance.changePasswordWithPin(changePasswordModel);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#changePasswordWithPin");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
changePasswordModel	SetPasswordWithPinModel

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

createAccount

createAccount(createAccountModel)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.AccountsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

AccountsApi apiInstance = new AccountsApi();
CreateAccountModel createAccountModel = new CreateAccountModel(); // CreateAccountModel | 
try {
    apiInstance.createAccount(createAccountModel);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#createAccount");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
createAccountModel	CreateAccountModel

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

createBasicAccount

String createBasicAccount(basicAccountModel)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.AccountsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

AccountsApi apiInstance = new AccountsApi();
CreateBasicAccountModel basicAccountModel = new CreateBasicAccountModel(); // CreateBasicAccountModel | 
try {
    String result = apiInstance.createBasicAccount(basicAccountModel);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#createBasicAccount");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
basicAccountModel	CreateBasicAccountModel

Return type

String

Authorization

oauth2

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

getAccountDetails

RestApiResultAccountDetail getAccountDetails()

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.AccountsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

AccountsApi apiInstance = new AccountsApi();
try {
    RestApiResultAccountDetail result = apiInstance.getAccountDetails();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#getAccountDetails");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

RestApiResultAccountDetail

Authorization

oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/json, application/xml, text/xml

getLocalisedTimeZones

RestApiArrayResultLocalisedTimeZone getLocalisedTimeZones()

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.AccountsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

AccountsApi apiInstance = new AccountsApi();
try {
    RestApiArrayResultLocalisedTimeZone result = apiInstance.getLocalisedTimeZones();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#getLocalisedTimeZones");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

RestApiArrayResultLocalisedTimeZone

Authorization

oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/json, application/xml, text/xml

login

login(loginModel)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.AccountsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

AccountsApi apiInstance = new AccountsApi();
LoginModel loginModel = new LoginModel(); // LoginModel | 
try {
    apiInstance.login(loginModel);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#login");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
loginModel	LoginModel

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

loginSso

loginSso()

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.AccountsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

AccountsApi apiInstance = new AccountsApi();
try {
    apiInstance.loginSso();
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#loginSso");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/json, application/xml, text/xml

loginWithPin

loginWithPin(loginModel)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.AccountsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

AccountsApi apiInstance = new AccountsApi();
LoginWithPinModel loginModel = new LoginWithPinModel(); // LoginWithPinModel | 
try {
    apiInstance.loginWithPin(loginModel);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#loginWithPin");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
loginModel	LoginWithPinModel

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

logout

logout()

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.AccountsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

AccountsApi apiInstance = new AccountsApi();
try {
    apiInstance.logout();
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#logout");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/json, application/xml, text/xml

passwordResetWithToken

passwordResetWithToken(passwordResetModel)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.AccountsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

AccountsApi apiInstance = new AccountsApi();
PasswordResetModel passwordResetModel = new PasswordResetModel(); // PasswordResetModel | 
try {
    apiInstance.passwordResetWithToken(passwordResetModel);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#passwordResetWithToken");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
passwordResetModel	PasswordResetModel

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

recaptchaValidate

recaptchaValidate(token)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.AccountsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

AccountsApi apiInstance = new AccountsApi();
String token = "token_example"; // String | 
try {
    apiInstance.recaptchaValidate(token);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#recaptchaValidate");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
token	String

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/json, application/xml, text/xml

requestLoginPin

RequestLoginPinResponse requestLoginPin(requestLoginPinRequest)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.AccountsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

AccountsApi apiInstance = new AccountsApi();
RequestLoginPinModel requestLoginPinRequest = new RequestLoginPinModel(); // RequestLoginPinModel | 
try {
    RequestLoginPinResponse result = apiInstance.requestLoginPin(requestLoginPinRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#requestLoginPin");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
requestLoginPinRequest	RequestLoginPinModel

Return type

RequestLoginPinResponse

Authorization

oauth2

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

requestPasswordReset

requestPasswordReset(requestPasswordResetModel)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.AccountsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

AccountsApi apiInstance = new AccountsApi();
RequestPasswordResetModel requestPasswordResetModel = new RequestPasswordResetModel(); // RequestPasswordResetModel | 
try {
    apiInstance.requestPasswordReset(requestPasswordResetModel);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#requestPasswordReset");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
requestPasswordResetModel	RequestPasswordResetModel

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

sendPinForPasswordReset

RequestPasswordResetPinResponse sendPinForPasswordReset(requestPasswordResetRequest)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.AccountsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

AccountsApi apiInstance = new AccountsApi();
RequestPasswordResetModel requestPasswordResetRequest = new RequestPasswordResetModel(); // RequestPasswordResetModel | 
try {
    RequestPasswordResetPinResponse result = apiInstance.sendPinForPasswordReset(requestPasswordResetRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#sendPinForPasswordReset");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
requestPasswordResetRequest	RequestPasswordResetModel

Return type

RequestPasswordResetPinResponse

Authorization

oauth2

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

skipSignupStep

skipSignupStep(signupStepAction)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.AccountsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

AccountsApi apiInstance = new AccountsApi();
String signupStepAction = "signupStepAction_example"; // String | 
try {
    apiInstance.skipSignupStep(signupStepAction);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#skipSignupStep");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
signupStepAction	String		[enum: Question, StoreLocation, PaymentSubscription, StoreName]

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/json, application/xml, text/xml

updateAccount

updateAccount(updateAccountModel)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.AccountsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

AccountsApi apiInstance = new AccountsApi();
AccountDetailBase updateAccountModel = new AccountDetailBase(); // AccountDetailBase | 
try {
    apiInstance.updateAccount(updateAccountModel);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#updateAccount");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
updateAccountModel	AccountDetailBase

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml