Skip to content

Latest commit

 

History

History
226 lines (162 loc) · 6.63 KB

CustomersApi.md

File metadata and controls

226 lines (162 loc) · 6.63 KB

CustomersApi

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

Method HTTP request Description
createCustomer POST /api/v1.0/{appId}/customers
getCustomerById GET /api/v1.0/{appId}/customers/{customerId}
getCustomers GET /api/v1.0/{appId}/customers
updateCustomerById POST /api/v1.0/{appId}/customers/{customerId}

createCustomer

RestApiResultCustomer createCustomer(appId, customerCreateModel)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

CustomersApi apiInstance = new CustomersApi();
String appId = "appId_example"; // String | 
CustomerCreateModel customerCreateModel = new CustomerCreateModel(); // CustomerCreateModel | 
try {
    RestApiResultCustomer result = apiInstance.createCustomer(appId, customerCreateModel);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#createCustomer");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
customerCreateModel CustomerCreateModel

Return type

RestApiResultCustomer

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

getCustomerById

RestApiResultCustomer getCustomerById(appId, customerId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name Type Description Notes
appId String
customerId Integer

Return type

RestApiResultCustomer

Authorization

oauth2

HTTP request headers

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

getCustomers

RestApiResultCustomers getCustomers(appId, phoneNumber)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

CustomersApi apiInstance = new CustomersApi();
String appId = "appId_example"; // String | 
String phoneNumber = "phoneNumber_example"; // String | 
try {
    RestApiResultCustomers result = apiInstance.getCustomers(appId, phoneNumber);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#getCustomers");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
phoneNumber String

Return type

RestApiResultCustomers

Authorization

oauth2

HTTP request headers

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

updateCustomerById

RestApiResultCustomer updateCustomerById(appId, customerId, updateCustomer)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

CustomersApi apiInstance = new CustomersApi();
String appId = "appId_example"; // String | 
Integer customerId = 56; // Integer | 
CustomerUpdateModel updateCustomer = new CustomerUpdateModel(); // CustomerUpdateModel | 
try {
    RestApiResultCustomer result = apiInstance.updateCustomerById(appId, customerId, updateCustomer);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CustomersApi#updateCustomerById");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
customerId Integer
updateCustomer CustomerUpdateModel

Return type

RestApiResultCustomer

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