Skip to content

CustomersApi.md

Latest commit

 

History

History
226 lines (158 loc) · 7.37 KB

CustomersApi.md

File metadata and controls

226 lines (158 loc) · 7.37 KB

Flipdish\Client\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

\Flipdish\Client\Models\RestApiResultCustomer createCustomer($app_id, $customer_create_model)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\CustomersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = "app_id_example"; // string | 
$customer_create_model = new \Flipdish\\Client\Models\CustomerCreateModel(); // \Flipdish\\Client\Models\CustomerCreateModel | 

try {
    $result = $apiInstance->createCustomer($app_id, $customer_create_model);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomersApi->createCustomer: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
app_id string
customer_create_model \Flipdish\Client\Models\CustomerCreateModel

Return type

\Flipdish\Client\Models\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

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

getCustomerById

\Flipdish\Client\Models\RestApiResultCustomer getCustomerById($app_id, $customer_id)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\CustomersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = "app_id_example"; // string | 
$customer_id = 56; // int | 

try {
    $result = $apiInstance->getCustomerById($app_id, $customer_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomersApi->getCustomerById: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
app_id string
customer_id int

Return type

\Flipdish\Client\Models\RestApiResultCustomer

Authorization

oauth2

HTTP request headers

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

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

getCustomers

\Flipdish\Client\Models\RestApiResultCustomers getCustomers($app_id, $phone_number)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\CustomersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = "app_id_example"; // string | 
$phone_number = "phone_number_example"; // string | 

try {
    $result = $apiInstance->getCustomers($app_id, $phone_number);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomersApi->getCustomers: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
app_id string
phone_number string

Return type

\Flipdish\Client\Models\RestApiResultCustomers

Authorization

oauth2

HTTP request headers

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

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

updateCustomerById

\Flipdish\Client\Models\RestApiResultCustomer updateCustomerById($app_id, $customer_id, $update_customer)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\CustomersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = "app_id_example"; // string | 
$customer_id = 56; // int | 
$update_customer = new \Flipdish\\Client\Models\CustomerUpdateModel(); // \Flipdish\\Client\Models\CustomerUpdateModel | 

try {
    $result = $apiInstance->updateCustomerById($app_id, $customer_id, $update_customer);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomersApi->updateCustomerById: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
app_id string
customer_id int
update_customer \Flipdish\Client\Models\CustomerUpdateModel

Return type

\Flipdish\Client\Models\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

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