Skip to content

UsersApi.md

Latest commit

 

History

History
1602 lines (1055 loc) · 40.9 KB

UsersApi.md

File metadata and controls

1602 lines (1055 loc) · 40.9 KB
Raw

Flipdish.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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
let note = "note_example"; // String | 
apiInstance.addUserNote(userId, note, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number
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, Data, Message

addUserToRole

RestApiResultUserRole addUserToRole(userId, roleName)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
let roleName = "roleName_example"; // String | 
apiInstance.addUserToRole(userId, roleName, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number
roleName String

Return type

RestApiResultUserRole

Authorization

oauth2

HTTP request headers

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

anonymizeUser

RestApiDefaultResponse anonymizeUser(userId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
apiInstance.anonymizeUser(userId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number

Return type

RestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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

blockUserPhoneNumber

RestApiDefaultResponse blockUserPhoneNumber(userId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
apiInstance.blockUserPhoneNumber(userId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number

Return type

RestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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

createUserDeliveryLocation

RestApiDefaultResponse createUserDeliveryLocation(userId, request)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
let request = new Flipdish.CreateUserDeliveryLocationRequest(); // CreateUserDeliveryLocationRequest | 
apiInstance.createUserDeliveryLocation(userId, request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number
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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
let storeId = 56; // Number | 
apiInstance.getPreviousOrderCountForStore(userId, storeId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number
storeId Number

Return type

RestApiStringResult

Authorization

oauth2

HTTP request headers

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

getRestaurantUserAccounts

RestApiArrayResultUserFlipdishAccount getRestaurantUserAccounts(userId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
apiInstance.getRestaurantUserAccounts(userId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number

Return type

RestApiArrayResultUserFlipdishAccount

Authorization

oauth2

HTTP request headers

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

getRestaurantUserStores

RestApiArrayResultUserStoreInfo getRestaurantUserStores(userId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
apiInstance.getRestaurantUserStores(userId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number

Return type

RestApiArrayResultUserStoreInfo

Authorization

oauth2

HTTP request headers

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

getRoles

RestApiStringArrayResult getRoles()

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
apiInstance.getRoles((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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, Data, Message

getRolesAndUnassignedRoles

RestApiResultUserRole getRolesAndUnassignedRoles(userId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
apiInstance.getRolesAndUnassignedRoles(userId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number

Return type

RestApiResultUserRole

Authorization

oauth2

HTTP request headers

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

getUserById

RestApiResultUserInfo getUserById(userId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
apiInstance.getUserById(userId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number

Return type

RestApiResultUserInfo

Authorization

oauth2

HTTP request headers

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

getUserDeliveryLocationsForAdmin

RestApiArrayResultUserDeliveryLocationAdmin getUserDeliveryLocationsForAdmin(userId, opts)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
let opts = {
  'whiteLabelId': 56 // Number | 
};
apiInstance.getUserDeliveryLocationsForAdmin(userId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number
whiteLabelId Number [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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
apiInstance.getUserNotes(userId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number

Return type

RestApiArrayResultUserNote

Authorization

oauth2

HTTP request headers

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

getUserOrderByIdForAdmin

RestApiResultOrder getUserOrderByIdForAdmin(userId, orderId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
let orderId = 56; // Number | 
apiInstance.getUserOrderByIdForAdmin(userId, orderId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number
orderId Number

Return type

RestApiResultOrder

Authorization

oauth2

HTTP request headers

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

getUserOrdersForAdmin

RestApiArrayResultUserOrderSummary getUserOrdersForAdmin(userId, opts)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
let opts = {
  'skip': 56, // Number | 
  'take': 56, // Number | 
  'brandId': "brandId_example" // String | 
};
apiInstance.getUserOrdersForAdmin(userId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number
skip Number [optional]
take Number [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, opts)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
let opts = {
  'mostRecentCount': 56 // Number | 
};
apiInstance.getUserSmsConversationItems(userId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number
mostRecentCount Number [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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
let deliveryLocationId = 56; // Number | 
apiInstance.hideUserDeliveryLocation(userId, deliveryLocationId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number
deliveryLocationId Number

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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
apiInstance.markUserAsFraudulent(userId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number

Return type

RestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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

markUserAsSuspicious

RestApiDefaultResponse markUserAsSuspicious(userId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
apiInstance.markUserAsSuspicious(userId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number

Return type

RestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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

removeFlipdishAccountIdForUser

RestApiDefaultResponse removeFlipdishAccountIdForUser(userId, accountId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
let accountId = 56; // Number | 
apiInstance.removeFlipdishAccountIdForUser(userId, accountId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number
accountId Number

Return type

RestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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

removeUserFromRole

RestApiResultUserRole removeUserFromRole(userId, roleName)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
let roleName = "roleName_example"; // String | 
apiInstance.removeUserFromRole(userId, roleName, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number
roleName String

Return type

RestApiResultUserRole

Authorization

oauth2

HTTP request headers

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

resetMfa

RestApiDefaultResponse resetMfa(userId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
apiInstance.resetMfa(userId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number

Return type

RestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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

searchFlipdishAccounts

RestApiArrayResultFlipdishAccountName searchFlipdishAccounts(searchPattern)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let searchPattern = "searchPattern_example"; // String | 
apiInstance.searchFlipdishAccounts(searchPattern, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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, Data, Message

searchUsers

RestApiPaginationResultUserSearch searchUsers(searchQuery, opts)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let searchQuery = "searchQuery_example"; // String | 
let opts = {
  'hasUserLoggedIn': true, // Boolean | 
  'userDiscriminator': "userDiscriminator_example", // String | 
  'searchIn': "searchIn_example", // String | 
  'pageIndex': 56, // Number | 
  'pageSize': 56 // Number | 
};
apiInstance.searchUsers(searchQuery, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
searchQuery String
hasUserLoggedIn Boolean [optional]
userDiscriminator String [optional]
searchIn String [optional]
pageIndex Number [optional]
pageSize Number [optional]

Return type

RestApiPaginationResultUserSearch

Authorization

oauth2

HTTP request headers

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

sendUserPushNotification

RestApiResultUserPushNotificationSentResult sendUserPushNotification(userId, request)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
let request = new Flipdish.SendUserPushNotificationRequest(); // SendUserPushNotificationRequest | 
apiInstance.sendUserPushNotification(userId, request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number
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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
let request = new Flipdish.SendUserSmsRequest(); // SendUserSmsRequest | 
apiInstance.sendUserSms(userId, request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number
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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
let customerName = "customerName_example"; // String | 
apiInstance.setCustomerName(userId, customerName, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number
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, Data, Message

setFlipdishAccountIdForUser

RestApiDefaultResponse setFlipdishAccountIdForUser(userId, accountId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
let accountId = 56; // Number | 
apiInstance.setFlipdishAccountIdForUser(userId, accountId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number
accountId Number

Return type

RestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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

setUserDeliveryLocationCoordinates

RestApiDefaultResponse setUserDeliveryLocationCoordinates(userId, deliveryLocationId, request)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
let deliveryLocationId = 56; // Number | 
let request = new Flipdish.SetUserDeliveryLocationCoordinatesRequest(); // SetUserDeliveryLocationCoordinatesRequest | 
apiInstance.setUserDeliveryLocationCoordinates(userId, deliveryLocationId, request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number
deliveryLocationId Number
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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
let deliveryLocationId = 56; // Number | 
let request = new Flipdish.SetUserDeliveryLocationFieldRequest(); // SetUserDeliveryLocationFieldRequest | 
apiInstance.setUserDeliveryLocationField(userId, deliveryLocationId, request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number
deliveryLocationId Number
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 Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
let languageId = "languageId_example"; // String | 
apiInstance.setUserLanguage(userId, languageId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number
languageId String

Return type

RestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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

unblockUserPhoneNumber

RestApiDefaultResponse unblockUserPhoneNumber(userId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.UsersApi();
let userId = 56; // Number | 
apiInstance.unblockUserPhoneNumber(userId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
userId Number

Return type

RestApiDefaultResponse

Authorization

oauth2

HTTP request headers

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