Skip to content

RestaurantVouchersPayGreenApi.md

Latest commit

 

History

History
494 lines (355 loc) · 17.2 KB

RestaurantVouchersPayGreenApi.md

File metadata and controls

494 lines (355 loc) · 17.2 KB
Raw

RestaurantVouchersPayGreenApi

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

Method HTTP request Description
createPayGreenConfiguration POST /api/v1.0/{appId}/restaurant-vouchers/paygreen
deletePayGreenConfiguration DELETE /api/v1.0/{appId}/restaurant-vouchers/paygreen/{paygreenConfigurationId}
getElegibleStores GET /api/v1.0/{appId}/restaurant-vouchers/paygreen/stores
getPayGreenConfigurations GET /api/v1.0/{appId}/restaurant-vouchers/paygreen
getStoreAvailablePayGreenConfigurations GET /api/v1.0/{appId}/restaurant-vouchers/paygreen/stores/{storeId}/available-configurations
getStorePayGreenConfiguration_ GET /api/v1.0/{appId}/restaurant-vouchers/paygreen/stores/{storeId}
listPayGreenConfigurations GET /api/v1.0/{appId}/restaurant-vouchers/paygreen/{paygreenConfigurationId}
updatePayGreenConfiguration POST /api/v1.0/{appId}/restaurant-vouchers/paygreen/{paygreenConfigurationId}
updateStorePayGreenConfiguration_ POST /api/v1.0/{appId}/restaurant-vouchers/paygreen/stores/{storeId}

createPayGreenConfiguration

RestApiResultRestaurantVoucherPayGreenConfiguration createPayGreenConfiguration(appId, request)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

RestaurantVouchersPayGreenApi apiInstance = new RestaurantVouchersPayGreenApi();
String appId = "appId_example"; // String | 
CreatePayGreenConfigurationRequest request = new CreatePayGreenConfigurationRequest(); // CreatePayGreenConfigurationRequest | 
try {
    RestApiResultRestaurantVoucherPayGreenConfiguration result = apiInstance.createPayGreenConfiguration(appId, request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RestaurantVouchersPayGreenApi#createPayGreenConfiguration");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
request CreatePayGreenConfigurationRequest

Return type

RestApiResultRestaurantVoucherPayGreenConfiguration

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

deletePayGreenConfiguration

Object deletePayGreenConfiguration(appId, paygreenConfigurationId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name Type Description Notes
appId String
paygreenConfigurationId Integer

Return type

Object

Authorization

oauth2

HTTP request headers

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

getElegibleStores

RestApiArrayResultRestaurantVoucherEligibleStore getElegibleStores(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.RestaurantVouchersPayGreenApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name Type Description Notes
appId String

Return type

RestApiArrayResultRestaurantVoucherEligibleStore

Authorization

oauth2

HTTP request headers

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

getPayGreenConfigurations

RestApiArrayResultRestaurantVoucherPayGreenConfiguration getPayGreenConfigurations(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.RestaurantVouchersPayGreenApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name Type Description Notes
appId String

Return type

RestApiArrayResultRestaurantVoucherPayGreenConfiguration

Authorization

oauth2

HTTP request headers

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

getStoreAvailablePayGreenConfigurations

RestApiArrayResultRestaurantVoucherPayGreenConfigurationSummary getStoreAvailablePayGreenConfigurations(appId, 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.RestaurantVouchersPayGreenApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name Type Description Notes
appId String
storeId Integer

Return type

RestApiArrayResultRestaurantVoucherPayGreenConfigurationSummary

Authorization

oauth2

HTTP request headers

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

getStorePayGreenConfiguration_

RestApiResultRestaurantVoucherPayGreenStoreConfiguration getStorePayGreenConfiguration_(appId, 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.RestaurantVouchersPayGreenApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name Type Description Notes
appId String
storeId Integer

Return type

RestApiResultRestaurantVoucherPayGreenStoreConfiguration

Authorization

oauth2

HTTP request headers

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

listPayGreenConfigurations

RestApiResultRestaurantVoucherPayGreenConfiguration listPayGreenConfigurations(appId, paygreenConfigurationId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name Type Description Notes
appId String
paygreenConfigurationId Integer

Return type

RestApiResultRestaurantVoucherPayGreenConfiguration

Authorization

oauth2

HTTP request headers

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

updatePayGreenConfiguration

RestApiResultRestaurantVoucherPayGreenConfiguration updatePayGreenConfiguration(appId, paygreenConfigurationId, request)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

RestaurantVouchersPayGreenApi apiInstance = new RestaurantVouchersPayGreenApi();
String appId = "appId_example"; // String | 
Integer paygreenConfigurationId = 56; // Integer | 
UpdatePayGreenConfigurationRequest request = new UpdatePayGreenConfigurationRequest(); // UpdatePayGreenConfigurationRequest | 
try {
    RestApiResultRestaurantVoucherPayGreenConfiguration result = apiInstance.updatePayGreenConfiguration(appId, paygreenConfigurationId, request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RestaurantVouchersPayGreenApi#updatePayGreenConfiguration");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
paygreenConfigurationId Integer
request UpdatePayGreenConfigurationRequest

Return type

RestApiResultRestaurantVoucherPayGreenConfiguration

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

updateStorePayGreenConfiguration_

RestApiResultRestaurantVoucherPayGreenStoreConfiguration updateStorePayGreenConfiguration_(appId, storeId, request)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

RestaurantVouchersPayGreenApi apiInstance = new RestaurantVouchersPayGreenApi();
String appId = "appId_example"; // String | 
Integer storeId = 56; // Integer | 
UpdateStorePayGreenConfigurationRequest request = new UpdateStorePayGreenConfigurationRequest(); // UpdateStorePayGreenConfigurationRequest | 
try {
    RestApiResultRestaurantVoucherPayGreenStoreConfiguration result = apiInstance.updateStorePayGreenConfiguration_(appId, storeId, request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RestaurantVouchersPayGreenApi#updateStorePayGreenConfiguration_");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
storeId Integer
request UpdateStorePayGreenConfigurationRequest

Return type

RestApiResultRestaurantVoucherPayGreenStoreConfiguration

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