Skip to content

UsersApi.md

Latest commit

 

History

History
1722 lines (1239 loc) · 50.4 KB

UsersApi.md

File metadata and controls

1722 lines (1239 loc) · 50.4 KB

UsersApi

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

Method HTTP request Description
addUserNote POST /api/v1.0/users/{userId}/AddUserNote
addUserToRole POST /api/v1.0/users/{userId}/AddUserToRole/{roleName}
anonymizeUser POST /api/v1.0/users/{userId}/AnonymizeUser
blockUserPhoneNumber POST /api/v1.0/users/{userId}/BlockUserPhoneNumber
createUserDeliveryLocation POST /api/v1.0/users/{userId}/deliveryLocations
getPreviousOrderCountForStore GET /api/v1.0/users/{userId}/previousordercount/{storeId}
getRestaurantUserAccounts GET /api/v1.0/users/{userId}/RestaurantUserAccounts
getRestaurantUserStores GET /api/v1.0/users/{userId}/RestaurantUserStores
getRoles GET /api/v1.0/users/roles
getRolesAndUnassignedRoles GET /api/v1.0/users/{userId}/roles
getUserById GET /api/v1.0/users/{userId}
getUserDeliveryLocationsForAdmin GET /api/v1.0/users/{userId}/deliveryLocations
getUserNotes GET /api/v1.0/users/{userId}/UserNotes
getUserOrderByIdForAdmin GET /api/v1.0/users/{userId}/orders/{orderId}
getUserOrdersForAdmin GET /api/v1.0/users/{userId}/orders
getUserSmsConversationItems GET /api/v1.0/users/{userId}/smsConversationItems
hideUserDeliveryLocation POST /api/v1.0/users/{userId}/deliveryLocations/{deliveryLocationId}/hide
markUserAsFraudulent POST /api/v1.0/users/{userId}/MarkUserAsFraudulent
markUserAsSuspicious POST /api/v1.0/users/{userId}/MarkUserAsSuspicious
removeFlipdishAccountIdForUser POST /api/v1.0/users/{userId}/RemoveFlipdishAccountId/{accountId}
removeUserFromRole POST /api/v1.0/users/{userId}/RemoveUserFromRole/{roleName}
resetMfa POST /api/v1.0/users/{userId}/ResetMfa
searchFlipdishAccounts GET /api/v1.0/users/searchFlipdishAccounts
searchUsers GET /api/v1.0/users/search
sendUserPushNotification POST /api/v1.0/users/{userId}/pushNotifications
sendUserSms POST /api/v1.0/users/{userId}/sms
setCustomerName POST /api/v1.0/users/{userId}/SetCustomerName
setFlipdishAccountIdForUser POST /api/v1.0/users/{userId}/SetFlipdishAccountId/{accountId}
setUserDeliveryLocationCoordinates POST /api/v1.0/users/{userId}/deliveryLocations/{deliveryLocationId}/coordinates
setUserDeliveryLocationField POST /api/v1.0/users/{userId}/deliveryLocations/{deliveryLocationId}/fields
setUserLanguage POST /api/v1.0/users/{userId}/SetLanguage/{languageId}
unblockUserPhoneNumber POST /api/v1.0/users/{userId}/UnblockUserPhoneNumber

addUserNote

RestApiDefaultResponse addUserNote(userId, note)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
String note = "note_example"; // String | 
try {
    RestApiDefaultResponse result = apiInstance.addUserNote(userId, note);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#addUserNote");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer
note String

Return type

RestApiDefaultResponse

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

addUserToRole

RestApiResultUserRole addUserToRole(userId, roleName)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
String roleName = "roleName_example"; // String | 
try {
    RestApiResultUserRole result = apiInstance.addUserToRole(userId, roleName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#addUserToRole");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer
roleName String

Return type

RestApiResultUserRole

Authorization

oauth2

HTTP request headers

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

anonymizeUser

RestApiDefaultResponse anonymizeUser(userId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
try {
    RestApiDefaultResponse result = apiInstance.anonymizeUser(userId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#anonymizeUser");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer

Return type

RestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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

blockUserPhoneNumber

RestApiDefaultResponse blockUserPhoneNumber(userId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
try {
    RestApiDefaultResponse result = apiInstance.blockUserPhoneNumber(userId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#blockUserPhoneNumber");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer

Return type

RestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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

createUserDeliveryLocation

RestApiDefaultResponse createUserDeliveryLocation(userId, 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.UsersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
CreateUserDeliveryLocationRequest request = new CreateUserDeliveryLocationRequest(); // CreateUserDeliveryLocationRequest | 
try {
    RestApiDefaultResponse result = apiInstance.createUserDeliveryLocation(userId, request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#createUserDeliveryLocation");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer
request CreateUserDeliveryLocationRequest

Return type

RestApiDefaultResponse

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

getPreviousOrderCountForStore

RestApiStringResult getPreviousOrderCountForStore(userId, 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.UsersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
Integer storeId = 56; // Integer | 
try {
    RestApiStringResult result = apiInstance.getPreviousOrderCountForStore(userId, storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#getPreviousOrderCountForStore");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer
storeId Integer

Return type

RestApiStringResult

Authorization

oauth2

HTTP request headers

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

getRestaurantUserAccounts

RestApiArrayResultUserFlipdishAccount getRestaurantUserAccounts(userId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
try {
    RestApiArrayResultUserFlipdishAccount result = apiInstance.getRestaurantUserAccounts(userId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#getRestaurantUserAccounts");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer

Return type

RestApiArrayResultUserFlipdishAccount

Authorization

oauth2

HTTP request headers

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

getRestaurantUserStores

RestApiArrayResultUserStoreInfo getRestaurantUserStores(userId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
try {
    RestApiArrayResultUserStoreInfo result = apiInstance.getRestaurantUserStores(userId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#getRestaurantUserStores");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer

Return type

RestApiArrayResultUserStoreInfo

Authorization

oauth2

HTTP request headers

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

getRoles

RestApiStringArrayResult getRoles()

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

This endpoint does not need any parameter.

Return type

RestApiStringArrayResult

Authorization

oauth2

HTTP request headers

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

getRolesAndUnassignedRoles

RestApiResultUserRole getRolesAndUnassignedRoles(userId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
try {
    RestApiResultUserRole result = apiInstance.getRolesAndUnassignedRoles(userId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#getRolesAndUnassignedRoles");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer

Return type

RestApiResultUserRole

Authorization

oauth2

HTTP request headers

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

getUserById

RestApiResultUserInfo getUserById(userId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
try {
    RestApiResultUserInfo result = apiInstance.getUserById(userId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#getUserById");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer

Return type

RestApiResultUserInfo

Authorization

oauth2

HTTP request headers

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

getUserDeliveryLocationsForAdmin

RestApiArrayResultUserDeliveryLocationAdmin getUserDeliveryLocationsForAdmin(userId, whiteLabelId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
Integer whiteLabelId = 56; // Integer | 
try {
    RestApiArrayResultUserDeliveryLocationAdmin result = apiInstance.getUserDeliveryLocationsForAdmin(userId, whiteLabelId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#getUserDeliveryLocationsForAdmin");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer
whiteLabelId Integer [optional]

Return type

RestApiArrayResultUserDeliveryLocationAdmin

Authorization

oauth2

HTTP request headers

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

getUserNotes

RestApiArrayResultUserNote getUserNotes(userId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
try {
    RestApiArrayResultUserNote result = apiInstance.getUserNotes(userId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#getUserNotes");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer

Return type

RestApiArrayResultUserNote

Authorization

oauth2

HTTP request headers

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

getUserOrderByIdForAdmin

RestApiResultOrder getUserOrderByIdForAdmin(userId, orderId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
Integer orderId = 56; // Integer | 
try {
    RestApiResultOrder result = apiInstance.getUserOrderByIdForAdmin(userId, orderId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#getUserOrderByIdForAdmin");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer
orderId Integer

Return type

RestApiResultOrder

Authorization

oauth2

HTTP request headers

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

getUserOrdersForAdmin

RestApiArrayResultUserOrderSummary getUserOrdersForAdmin(userId, skip, take, brandId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
Integer skip = 56; // Integer | 
Integer take = 56; // Integer | 
String brandId = "brandId_example"; // String | 
try {
    RestApiArrayResultUserOrderSummary result = apiInstance.getUserOrdersForAdmin(userId, skip, take, brandId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#getUserOrdersForAdmin");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer
skip Integer [optional]
take Integer [optional]
brandId String [optional]

Return type

RestApiArrayResultUserOrderSummary

Authorization

oauth2

HTTP request headers

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

getUserSmsConversationItems

RestApiArrayResultUserSmsChatItem getUserSmsConversationItems(userId, mostRecentCount)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
Integer mostRecentCount = 56; // Integer | 
try {
    RestApiArrayResultUserSmsChatItem result = apiInstance.getUserSmsConversationItems(userId, mostRecentCount);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#getUserSmsConversationItems");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer
mostRecentCount Integer [optional]

Return type

RestApiArrayResultUserSmsChatItem

Authorization

oauth2

HTTP request headers

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

hideUserDeliveryLocation

RestApiDefaultResponse hideUserDeliveryLocation(userId, deliveryLocationId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
Integer deliveryLocationId = 56; // Integer | 
try {
    RestApiDefaultResponse result = apiInstance.hideUserDeliveryLocation(userId, deliveryLocationId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#hideUserDeliveryLocation");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer
deliveryLocationId Integer

Return type

RestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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

markUserAsFraudulent

RestApiDefaultResponse markUserAsFraudulent(userId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
try {
    RestApiDefaultResponse result = apiInstance.markUserAsFraudulent(userId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#markUserAsFraudulent");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer

Return type

RestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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

markUserAsSuspicious

RestApiDefaultResponse markUserAsSuspicious(userId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
try {
    RestApiDefaultResponse result = apiInstance.markUserAsSuspicious(userId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#markUserAsSuspicious");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer

Return type

RestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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

removeFlipdishAccountIdForUser

RestApiDefaultResponse removeFlipdishAccountIdForUser(userId, accountId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
Integer accountId = 56; // Integer | 
try {
    RestApiDefaultResponse result = apiInstance.removeFlipdishAccountIdForUser(userId, accountId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#removeFlipdishAccountIdForUser");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer
accountId Integer

Return type

RestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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

removeUserFromRole

RestApiResultUserRole removeUserFromRole(userId, roleName)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
String roleName = "roleName_example"; // String | 
try {
    RestApiResultUserRole result = apiInstance.removeUserFromRole(userId, roleName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#removeUserFromRole");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer
roleName String

Return type

RestApiResultUserRole

Authorization

oauth2

HTTP request headers

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

resetMfa

RestApiDefaultResponse resetMfa(userId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
try {
    RestApiDefaultResponse result = apiInstance.resetMfa(userId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#resetMfa");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer

Return type

RestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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

searchFlipdishAccounts

RestApiArrayResultFlipdishAccountName searchFlipdishAccounts(searchPattern)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
String searchPattern = "searchPattern_example"; // String | 
try {
    RestApiArrayResultFlipdishAccountName result = apiInstance.searchFlipdishAccounts(searchPattern);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#searchFlipdishAccounts");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
searchPattern String

Return type

RestApiArrayResultFlipdishAccountName

Authorization

oauth2

HTTP request headers

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

searchUsers

RestApiPaginationResultUserSearch searchUsers(searchQuery, hasUserLoggedIn, userDiscriminator, searchIn, pageIndex, pageSize)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
String searchQuery = "searchQuery_example"; // String | 
Boolean hasUserLoggedIn = true; // Boolean | 
String userDiscriminator = "userDiscriminator_example"; // String | 
String searchIn = "searchIn_example"; // String | 
Integer pageIndex = 56; // Integer | 
Integer pageSize = 56; // Integer | 
try {
    RestApiPaginationResultUserSearch result = apiInstance.searchUsers(searchQuery, hasUserLoggedIn, userDiscriminator, searchIn, pageIndex, pageSize);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#searchUsers");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
searchQuery String
hasUserLoggedIn Boolean [optional]
userDiscriminator String [optional] [enum: All, ApplicationUsers, RestaurantUsers, HydraUsers]
searchIn String [optional] [enum: Generic, Id, Email, Phone, CustomerName, IdOrPhone, IdOrCustomerName]
pageIndex Integer [optional]
pageSize Integer [optional]

Return type

RestApiPaginationResultUserSearch

Authorization

oauth2

HTTP request headers

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

sendUserPushNotification

RestApiResultUserPushNotificationSentResult sendUserPushNotification(userId, 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.UsersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
SendUserPushNotificationRequest request = new SendUserPushNotificationRequest(); // SendUserPushNotificationRequest | 
try {
    RestApiResultUserPushNotificationSentResult result = apiInstance.sendUserPushNotification(userId, request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#sendUserPushNotification");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer
request SendUserPushNotificationRequest

Return type

RestApiResultUserPushNotificationSentResult

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

sendUserSms

RestApiDefaultResponse sendUserSms(userId, 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.UsersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
SendUserSmsRequest request = new SendUserSmsRequest(); // SendUserSmsRequest | 
try {
    RestApiDefaultResponse result = apiInstance.sendUserSms(userId, request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#sendUserSms");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer
request SendUserSmsRequest

Return type

RestApiDefaultResponse

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

setCustomerName

RestApiDefaultResponse setCustomerName(userId, customerName)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
String customerName = "customerName_example"; // String | 
try {
    RestApiDefaultResponse result = apiInstance.setCustomerName(userId, customerName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#setCustomerName");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer
customerName String

Return type

RestApiDefaultResponse

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

setFlipdishAccountIdForUser

RestApiDefaultResponse setFlipdishAccountIdForUser(userId, accountId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
Integer accountId = 56; // Integer | 
try {
    RestApiDefaultResponse result = apiInstance.setFlipdishAccountIdForUser(userId, accountId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#setFlipdishAccountIdForUser");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer
accountId Integer

Return type

RestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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

setUserDeliveryLocationCoordinates

RestApiDefaultResponse setUserDeliveryLocationCoordinates(userId, deliveryLocationId, 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.UsersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
Integer deliveryLocationId = 56; // Integer | 
SetUserDeliveryLocationCoordinatesRequest request = new SetUserDeliveryLocationCoordinatesRequest(); // SetUserDeliveryLocationCoordinatesRequest | 
try {
    RestApiDefaultResponse result = apiInstance.setUserDeliveryLocationCoordinates(userId, deliveryLocationId, request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#setUserDeliveryLocationCoordinates");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer
deliveryLocationId Integer
request SetUserDeliveryLocationCoordinatesRequest

Return type

RestApiDefaultResponse

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

setUserDeliveryLocationField

RestApiDefaultResponse setUserDeliveryLocationField(userId, deliveryLocationId, 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.UsersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
Integer deliveryLocationId = 56; // Integer | 
SetUserDeliveryLocationFieldRequest request = new SetUserDeliveryLocationFieldRequest(); // SetUserDeliveryLocationFieldRequest | 
try {
    RestApiDefaultResponse result = apiInstance.setUserDeliveryLocationField(userId, deliveryLocationId, request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#setUserDeliveryLocationField");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer
deliveryLocationId Integer
request SetUserDeliveryLocationFieldRequest

Return type

RestApiDefaultResponse

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

setUserLanguage

RestApiDefaultResponse setUserLanguage(userId, languageId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
String languageId = "languageId_example"; // String | 
try {
    RestApiDefaultResponse result = apiInstance.setUserLanguage(userId, languageId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#setUserLanguage");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer
languageId String

Return type

RestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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

unblockUserPhoneNumber

RestApiDefaultResponse unblockUserPhoneNumber(userId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

UsersApi apiInstance = new UsersApi();
Integer userId = 56; // Integer | 
try {
    RestApiDefaultResponse result = apiInstance.unblockUserPhoneNumber(userId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#unblockUserPhoneNumber");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
userId Integer

Return type

RestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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