Skip to content

Latest commit

 

History

History
1302 lines (941 loc) · 37 KB

HydraApi.md

File metadata and controls

1302 lines (941 loc) · 37 KB

HydraApi

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

Method HTTP request Description
assignEmv POST /api/v1.0/{appId}/hydra/emvterminal/assign/{hydraConfigId}/{emvTerminalId}
attachStoreToKiosk POST /api/v1.0/{appId}/AttachStoreToKiosk/{deviceId}/store/{storeId}
attachStoreToTerminal POST /api/v1.0/{appId}/hydra/{deviceId}/attach/{storeId}
cancelEmvPayment POST /api/v1.0/{appId}/hydra/cancelemvpayment/{orderId}
detachStoreFromTerminal POST /api/v1.0/{appId}/hydra/{deviceId}/detach/{storeId}
getAblyToken GET /api/v1.0/hydra/ably_token
getAttachedDevice GET /api/v1.0/{appId}/hydra/{deviceType}/{deviceId}
getAttachedDevices GET /api/v1.0/{appId}/hydra/{deviceType}/list
getEMVTerminalDetails GET /api/v1.0/{appId}/hydra/emvterminal
getEmvOrderState GET /api/v1.0/{appId}/hydra/emvorderstate/{orderId}
getKioskCashPaymentSettings GET /api/v1.0/{appId}/kioskcashsettings/{deviceId}
getKioskSettings GET /api/v1.0/{appId}/kiosksettings/{deviceId}
getRegistration GET /api/v1.0/hydra/registration
getSettings GET /api/v1.0/hydra/settings
hydraCreateEmv POST /api/v1.0/{appId}/emvterminals
hydraDeleteEmv DELETE /api/v1.0/{appId}/emvterminals/{id}
hydraDetachStoreFromKiosk DELETE /api/v1.0/{appId}/DetachStoreFromKiosk/{deviceId}/store/{storeId}
hydraGetEmvsForAppId GET /api/v1.0/{appId}/emvterminals
loginWithDeviceId POST /api/v1.0/hydra/{deviceId}/login
register POST /api/v1.0/{appId}/hydra/registration
unAssign DELETE /api/v1.0/{appId}/hydra/{deviceId}/registration
unassignEmv POST /api/v1.0/{appId}/hydra/emvterminal/unassign/{hydraConfigId}
updateKioskCashVisibilitySettings POST /api/v1.0/{appId}/kioskupdatecashsettings
updateKioskSettings POST /api/v1.0/{appId}/kiosksettings/{deviceId}

assignEmv

assignEmv(appId, hydraConfigId, emvTerminalId)

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
String appId = "appId_example"; // String | 
Integer hydraConfigId = 56; // Integer | 
Integer emvTerminalId = 56; // Integer | 
try {
    apiInstance.assignEmv(appId, hydraConfigId, emvTerminalId);
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#assignEmv");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
hydraConfigId Integer
emvTerminalId Integer

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

attachStoreToKiosk

RestApiResultHydraStatus attachStoreToKiosk(appId, storeId, deviceId)

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
String appId = "appId_example"; // String | 
Integer storeId = 56; // Integer | 
String deviceId = "deviceId_example"; // String | 
try {
    RestApiResultHydraStatus result = apiInstance.attachStoreToKiosk(appId, storeId, deviceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#attachStoreToKiosk");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
storeId Integer
deviceId String

Return type

RestApiResultHydraStatus

Authorization

oauth2

HTTP request headers

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

attachStoreToTerminal

RestApiResultHydraStatus attachStoreToTerminal(appId, deviceId, storeId)

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
String appId = "appId_example"; // String | 
String deviceId = "deviceId_example"; // String | 
Integer storeId = 56; // Integer | 
try {
    RestApiResultHydraStatus result = apiInstance.attachStoreToTerminal(appId, deviceId, storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#attachStoreToTerminal");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
deviceId String
storeId Integer

Return type

RestApiResultHydraStatus

Authorization

oauth2

HTTP request headers

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

cancelEmvPayment

cancelEmvPayment(orderId, appId)

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
Integer orderId = 56; // Integer | 
String appId = "appId_example"; // String | 
try {
    apiInstance.cancelEmvPayment(orderId, appId);
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#cancelEmvPayment");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
orderId Integer
appId 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

detachStoreFromTerminal

RestApiResultHydraStatus detachStoreFromTerminal(appId, deviceId, storeId)

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
String appId = "appId_example"; // String | 
String deviceId = "deviceId_example"; // String | 
Integer storeId = 56; // Integer | 
try {
    RestApiResultHydraStatus result = apiInstance.detachStoreFromTerminal(appId, deviceId, storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#detachStoreFromTerminal");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
deviceId String
storeId Integer

Return type

RestApiResultHydraStatus

Authorization

oauth2

HTTP request headers

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

getAblyToken

getAblyToken()

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
try {
    apiInstance.getAblyToken();
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#getAblyToken");
    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

getAttachedDevice

RestApiResultHydraDeviceDetails getAttachedDevice(appId, deviceType, deviceId)

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
String appId = "appId_example"; // String | 
String deviceType = "deviceType_example"; // String | 
String deviceId = "deviceId_example"; // String | 
try {
    RestApiResultHydraDeviceDetails result = apiInstance.getAttachedDevice(appId, deviceType, deviceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#getAttachedDevice");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
deviceType String [enum: Kiosk, Terminal, LegacyPrinter]
deviceId String

Return type

RestApiResultHydraDeviceDetails

Authorization

oauth2

HTTP request headers

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

getAttachedDevices

RestApiPaginationResultHydraDeviceDetails getAttachedDevices(appId, deviceType, pageIndex, pageSize, storeId, deviceName, deviceSerial)

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
String appId = "appId_example"; // String | 
String deviceType = "deviceType_example"; // String | 
Integer pageIndex = 56; // Integer | 
Integer pageSize = 56; // Integer | 
Integer storeId = 56; // Integer | 
String deviceName = "deviceName_example"; // String | 
String deviceSerial = "deviceSerial_example"; // String | 
try {
    RestApiPaginationResultHydraDeviceDetails result = apiInstance.getAttachedDevices(appId, deviceType, pageIndex, pageSize, storeId, deviceName, deviceSerial);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#getAttachedDevices");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
deviceType String [enum: Kiosk, Terminal, LegacyPrinter]
pageIndex Integer [optional]
pageSize Integer [optional]
storeId Integer [optional]
deviceName String [optional]
deviceSerial String [optional]

Return type

RestApiPaginationResultHydraDeviceDetails

Authorization

oauth2

HTTP request headers

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

getEMVTerminalDetails

RestApiResultPaymentTerminalDetails getEMVTerminalDetails(appId)

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
String appId = "appId_example"; // String | 
try {
    RestApiResultPaymentTerminalDetails result = apiInstance.getEMVTerminalDetails(appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#getEMVTerminalDetails");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String

Return type

RestApiResultPaymentTerminalDetails

Authorization

oauth2

HTTP request headers

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

getEmvOrderState

RestApiResultPaymentTerminalTransactionDetails getEmvOrderState(orderId, appId)

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
Integer orderId = 56; // Integer | 
String appId = "appId_example"; // String | 
try {
    RestApiResultPaymentTerminalTransactionDetails result = apiInstance.getEmvOrderState(orderId, appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#getEmvOrderState");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
orderId Integer
appId String

Return type

RestApiResultPaymentTerminalTransactionDetails

Authorization

oauth2

HTTP request headers

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

getKioskCashPaymentSettings

RestApiArrayResultKioskCashPaymentSettings getKioskCashPaymentSettings(appId, deviceId)

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
String appId = "appId_example"; // String | 
String deviceId = "deviceId_example"; // String | 
try {
    RestApiArrayResultKioskCashPaymentSettings result = apiInstance.getKioskCashPaymentSettings(appId, deviceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#getKioskCashPaymentSettings");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
deviceId String

Return type

RestApiArrayResultKioskCashPaymentSettings

Authorization

oauth2

HTTP request headers

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

getKioskSettings

RestApiResultKioskSettings getKioskSettings(appId, deviceId)

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
String appId = "appId_example"; // String | 
String deviceId = "deviceId_example"; // String | 
try {
    RestApiResultKioskSettings result = apiInstance.getKioskSettings(appId, deviceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#getKioskSettings");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
deviceId String

Return type

RestApiResultKioskSettings

Authorization

oauth2

HTTP request headers

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

getRegistration

RestApiResultHydraStatus getRegistration()

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

This endpoint does not need any parameter.

Return type

RestApiResultHydraStatus

Authorization

oauth2

HTTP request headers

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

getSettings

RestApiResultHydraConfig getSettings()

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

This endpoint does not need any parameter.

Return type

RestApiResultHydraConfig

Authorization

oauth2

HTTP request headers

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

hydraCreateEmv

Object hydraCreateEmv(appId, emv)

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
String appId = "appId_example"; // String | 
EmvTerminal emv = new EmvTerminal(); // EmvTerminal | 
try {
    Object result = apiInstance.hydraCreateEmv(appId, emv);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#hydraCreateEmv");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
emv EmvTerminal

Return type

Object

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

hydraDeleteEmv

Object hydraDeleteEmv(appId, id)

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
String appId = "appId_example"; // String | 
Integer id = 56; // Integer | 
try {
    Object result = apiInstance.hydraDeleteEmv(appId, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#hydraDeleteEmv");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
id Integer

Return type

Object

Authorization

oauth2

HTTP request headers

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

hydraDetachStoreFromKiosk

RestApiResultHydraStatus hydraDetachStoreFromKiosk(appId, storeId, deviceId)

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
String appId = "appId_example"; // String | 
Integer storeId = 56; // Integer | 
String deviceId = "deviceId_example"; // String | 
try {
    RestApiResultHydraStatus result = apiInstance.hydraDetachStoreFromKiosk(appId, storeId, deviceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#hydraDetachStoreFromKiosk");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
storeId Integer
deviceId String

Return type

RestApiResultHydraStatus

Authorization

oauth2

HTTP request headers

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

hydraGetEmvsForAppId

RestApiArrayResultEmvTerminalWithAssignments hydraGetEmvsForAppId(appId)

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
String appId = "appId_example"; // String | 
try {
    RestApiArrayResultEmvTerminalWithAssignments result = apiInstance.hydraGetEmvsForAppId(appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#hydraGetEmvsForAppId");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String

Return type

RestApiArrayResultEmvTerminalWithAssignments

Authorization

oauth2

HTTP request headers

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

loginWithDeviceId

loginWithDeviceId(deviceId, hydraUserType, serialNumber)

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
String deviceId = "deviceId_example"; // String | 
String hydraUserType = "hydraUserType_example"; // String | 
String serialNumber = "serialNumber_example"; // String | 
try {
    apiInstance.loginWithDeviceId(deviceId, hydraUserType, serialNumber);
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#loginWithDeviceId");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
deviceId String
hydraUserType String [optional] [enum: Kiosk, Terminal, LegacyPrinter]
serialNumber String [optional]

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

register

RestApiResultHydraStatus register(appId, hydraRegistration)

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
String appId = "appId_example"; // String | 
HydraRegistrationRequest hydraRegistration = new HydraRegistrationRequest(); // HydraRegistrationRequest | 
try {
    RestApiResultHydraStatus result = apiInstance.register(appId, hydraRegistration);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#register");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
hydraRegistration HydraRegistrationRequest

Return type

RestApiResultHydraStatus

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

unAssign

unAssign(appId, deviceId)

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
String appId = "appId_example"; // String | 
String deviceId = "deviceId_example"; // String | 
try {
    apiInstance.unAssign(appId, deviceId);
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#unAssign");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
deviceId 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

unassignEmv

unassignEmv(appId, hydraConfigId)

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
String appId = "appId_example"; // String | 
Integer hydraConfigId = 56; // Integer | 
try {
    apiInstance.unassignEmv(appId, hydraConfigId);
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#unassignEmv");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
hydraConfigId Integer

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

updateKioskCashVisibilitySettings

updateKioskCashVisibilitySettings(appId, deviceId, isCashEnabled)

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
String appId = "appId_example"; // String | 
String deviceId = "deviceId_example"; // String | 
Boolean isCashEnabled = true; // Boolean | 
try {
    apiInstance.updateKioskCashVisibilitySettings(appId, deviceId, isCashEnabled);
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#updateKioskCashVisibilitySettings");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
deviceId String
isCashEnabled Boolean

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

updateKioskSettings

updateKioskSettings(appId, deviceId, settings)

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.HydraApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

HydraApi apiInstance = new HydraApi();
String appId = "appId_example"; // String | 
String deviceId = "deviceId_example"; // String | 
KioskSettings settings = new KioskSettings(); // KioskSettings | 
try {
    apiInstance.updateKioskSettings(appId, deviceId, settings);
} catch (ApiException e) {
    System.err.println("Exception when calling HydraApi#updateKioskSettings");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
deviceId String
settings KioskSettings

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