Skip to content

Latest commit

 

History

History
1542 lines (1157 loc) · 41.7 KB

HydraApi.md

File metadata and controls

1542 lines (1157 loc) · 41.7 KB

Flipdish.Api.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

void AssignEmv (string appId, int? hydraConfigId, int? emvTerminalId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class AssignEmvExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();
            var appId = appId_example;  // string | 
            var hydraConfigId = 56;  // int? | 
            var emvTerminalId = 56;  // int? | 

            try
            {
                apiInstance.AssignEmv(appId, hydraConfigId, emvTerminalId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.AssignEmv: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
hydraConfigId int?
emvTerminalId int?

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AttachStoreToKiosk

RestApiResultHydraStatus AttachStoreToKiosk (string appId, int? storeId, string deviceId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class AttachStoreToKioskExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();
            var appId = appId_example;  // string | 
            var storeId = 56;  // int? | 
            var deviceId = deviceId_example;  // string | 

            try
            {
                RestApiResultHydraStatus result = apiInstance.AttachStoreToKiosk(appId, storeId, deviceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.AttachStoreToKiosk: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
storeId int?
deviceId string

Return type

RestApiResultHydraStatus

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AttachStoreToTerminal

RestApiResultHydraStatus AttachStoreToTerminal (string appId, string deviceId, int? storeId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class AttachStoreToTerminalExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();
            var appId = appId_example;  // string | 
            var deviceId = deviceId_example;  // string | 
            var storeId = 56;  // int? | 

            try
            {
                RestApiResultHydraStatus result = apiInstance.AttachStoreToTerminal(appId, deviceId, storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.AttachStoreToTerminal: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
deviceId string
storeId int?

Return type

RestApiResultHydraStatus

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CancelEmvPayment

void CancelEmvPayment (int? orderId, string appId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class CancelEmvPaymentExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();
            var orderId = 56;  // int? | 
            var appId = appId_example;  // string | 

            try
            {
                apiInstance.CancelEmvPayment(orderId, appId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.CancelEmvPayment: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
orderId int?
appId string

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DetachStoreFromTerminal

RestApiResultHydraStatus DetachStoreFromTerminal (string appId, string deviceId, int? storeId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class DetachStoreFromTerminalExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();
            var appId = appId_example;  // string | 
            var deviceId = deviceId_example;  // string | 
            var storeId = 56;  // int? | 

            try
            {
                RestApiResultHydraStatus result = apiInstance.DetachStoreFromTerminal(appId, deviceId, storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.DetachStoreFromTerminal: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
deviceId string
storeId int?

Return type

RestApiResultHydraStatus

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAblyToken

void GetAblyToken ()

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetAblyTokenExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();

            try
            {
                apiInstance.GetAblyToken();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.GetAblyToken: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAttachedDevice

RestApiResultHydraDeviceDetails GetAttachedDevice (string appId, string deviceType, string deviceId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetAttachedDeviceExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();
            var appId = appId_example;  // string | 
            var deviceType = deviceType_example;  // string | 
            var deviceId = deviceId_example;  // string | 

            try
            {
                RestApiResultHydraDeviceDetails result = apiInstance.GetAttachedDevice(appId, deviceType, deviceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.GetAttachedDevice: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
deviceType string
deviceId string

Return type

RestApiResultHydraDeviceDetails

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAttachedDevices

RestApiPaginationResultHydraDeviceDetails GetAttachedDevices (string appId, string deviceType, int? pageIndex = null, int? pageSize = null, int? storeId = null, string deviceName = null, string deviceSerial = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetAttachedDevicesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();
            var appId = appId_example;  // string | 
            var deviceType = deviceType_example;  // string | 
            var pageIndex = 56;  // int? |  (optional) 
            var pageSize = 56;  // int? |  (optional) 
            var storeId = 56;  // int? |  (optional) 
            var deviceName = deviceName_example;  // string |  (optional) 
            var deviceSerial = deviceSerial_example;  // string |  (optional) 

            try
            {
                RestApiPaginationResultHydraDeviceDetails result = apiInstance.GetAttachedDevices(appId, deviceType, pageIndex, pageSize, storeId, deviceName, deviceSerial);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.GetAttachedDevices: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
deviceType string
pageIndex int? [optional]
pageSize int? [optional]
storeId int? [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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEMVTerminalDetails

RestApiResultPaymentTerminalDetails GetEMVTerminalDetails (string appId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetEMVTerminalDetailsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();
            var appId = appId_example;  // string | 

            try
            {
                RestApiResultPaymentTerminalDetails result = apiInstance.GetEMVTerminalDetails(appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.GetEMVTerminalDetails: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEmvOrderState

RestApiResultPaymentTerminalTransactionDetails GetEmvOrderState (int? orderId, string appId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetEmvOrderStateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();
            var orderId = 56;  // int? | 
            var appId = appId_example;  // string | 

            try
            {
                RestApiResultPaymentTerminalTransactionDetails result = apiInstance.GetEmvOrderState(orderId, appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.GetEmvOrderState: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
orderId int?
appId string

Return type

RestApiResultPaymentTerminalTransactionDetails

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetKioskCashPaymentSettings

RestApiArrayResultKioskCashPaymentSettings GetKioskCashPaymentSettings (string appId, string deviceId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetKioskCashPaymentSettingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();
            var appId = appId_example;  // string | 
            var deviceId = deviceId_example;  // string | 

            try
            {
                RestApiArrayResultKioskCashPaymentSettings result = apiInstance.GetKioskCashPaymentSettings(appId, deviceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.GetKioskCashPaymentSettings: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetKioskSettings

RestApiResultKioskSettings GetKioskSettings (string appId, string deviceId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetKioskSettingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();
            var appId = appId_example;  // string | 
            var deviceId = deviceId_example;  // string | 

            try
            {
                RestApiResultKioskSettings result = apiInstance.GetKioskSettings(appId, deviceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.GetKioskSettings: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRegistration

RestApiResultHydraStatus GetRegistration ()

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetRegistrationExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();

            try
            {
                RestApiResultHydraStatus result = apiInstance.GetRegistration();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.GetRegistration: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSettings

RestApiResultHydraConfig GetSettings ()

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetSettingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();

            try
            {
                RestApiResultHydraConfig result = apiInstance.GetSettings();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.GetSettings: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HydraCreateEmv

Object HydraCreateEmv (string appId, EmvTerminal emv)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class HydraCreateEmvExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();
            var appId = appId_example;  // string | 
            var emv = new EmvTerminal(); // EmvTerminal | 

            try
            {
                Object result = apiInstance.HydraCreateEmv(appId, emv);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.HydraCreateEmv: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HydraDeleteEmv

Object HydraDeleteEmv (string appId, int? id)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class HydraDeleteEmvExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();
            var appId = appId_example;  // string | 
            var id = 56;  // int? | 

            try
            {
                Object result = apiInstance.HydraDeleteEmv(appId, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.HydraDeleteEmv: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
id int?

Return type

Object

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HydraDetachStoreFromKiosk

RestApiResultHydraStatus HydraDetachStoreFromKiosk (string appId, int? storeId, string deviceId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class HydraDetachStoreFromKioskExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();
            var appId = appId_example;  // string | 
            var storeId = 56;  // int? | 
            var deviceId = deviceId_example;  // string | 

            try
            {
                RestApiResultHydraStatus result = apiInstance.HydraDetachStoreFromKiosk(appId, storeId, deviceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.HydraDetachStoreFromKiosk: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
storeId int?
deviceId string

Return type

RestApiResultHydraStatus

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HydraGetEmvsForAppId

RestApiArrayResultEmvTerminalWithAssignments HydraGetEmvsForAppId (string appId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class HydraGetEmvsForAppIdExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();
            var appId = appId_example;  // string | 

            try
            {
                RestApiArrayResultEmvTerminalWithAssignments result = apiInstance.HydraGetEmvsForAppId(appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.HydraGetEmvsForAppId: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LoginWithDeviceId

void LoginWithDeviceId (string deviceId, string hydraUserType = null, string serialNumber = null)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class LoginWithDeviceIdExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();
            var deviceId = deviceId_example;  // string | 
            var hydraUserType = hydraUserType_example;  // string |  (optional) 
            var serialNumber = serialNumber_example;  // string |  (optional) 

            try
            {
                apiInstance.LoginWithDeviceId(deviceId, hydraUserType, serialNumber);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.LoginWithDeviceId: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
deviceId string
hydraUserType string [optional]
serialNumber string [optional]

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Register

RestApiResultHydraStatus Register (string appId, HydraRegistrationRequest hydraRegistration)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class RegisterExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();
            var appId = appId_example;  // string | 
            var hydraRegistration = new HydraRegistrationRequest(); // HydraRegistrationRequest | 

            try
            {
                RestApiResultHydraStatus result = apiInstance.Register(appId, hydraRegistration);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.Register: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UnAssign

void UnAssign (string appId, string deviceId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class UnAssignExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();
            var appId = appId_example;  // string | 
            var deviceId = deviceId_example;  // string | 

            try
            {
                apiInstance.UnAssign(appId, deviceId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.UnAssign: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
deviceId string

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UnassignEmv

void UnassignEmv (string appId, int? hydraConfigId)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class UnassignEmvExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();
            var appId = appId_example;  // string | 
            var hydraConfigId = 56;  // int? | 

            try
            {
                apiInstance.UnassignEmv(appId, hydraConfigId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.UnassignEmv: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
hydraConfigId int?

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateKioskCashVisibilitySettings

void UpdateKioskCashVisibilitySettings (string appId, string deviceId, bool? isCashEnabled)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class UpdateKioskCashVisibilitySettingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();
            var appId = appId_example;  // string | 
            var deviceId = deviceId_example;  // string | 
            var isCashEnabled = true;  // bool? | 

            try
            {
                apiInstance.UpdateKioskCashVisibilitySettings(appId, deviceId, isCashEnabled);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.UpdateKioskCashVisibilitySettings: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
deviceId string
isCashEnabled bool?

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateKioskSettings

void UpdateKioskSettings (string appId, string deviceId, KioskSettings settings)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class UpdateKioskSettingsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new HydraApi();
            var appId = appId_example;  // string | 
            var deviceId = deviceId_example;  // string | 
            var settings = new KioskSettings(); // KioskSettings | 

            try
            {
                apiInstance.UpdateKioskSettings(appId, deviceId, settings);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HydraApi.UpdateKioskSettings: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
deviceId string
settings KioskSettings

Return type

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]