Flipdish\Client\DriversApi

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

Method	HTTP request	Description
driversAddDriverNotificationToken	POST /api/v1.0/drivers/token
driversDeleteDriverProfileImage	DELETE /api/v1.0/drivers/profile/image
driversDriverLogin	POST /api/v1.0/drivers/login
driversDriverRequestLoginCodeSms	POST /api/v1.0/drivers/pin
driversGetDriverProfile	GET /api/v1.0/drivers/profile
driversGetStoresForDriver	GET /api/v1.0/drivers/assignedstores
driversRemoveDriverNotificationToken	DELETE /api/v1.0/drivers/token
driversSetDriverPresenceForStore	POST /api/v1.0/drivers/stores/{storeId}/presence/{presence}
driversSetDriverProfileImage	POST /api/v1.0/drivers/profile/image
driversUpdateDeliveryTrackingStatus	POST /api/v1.0/orders/{orderId}/tracking/{deliveryTrackingStatus}
driversUpdateDriverProfile	POST /api/v1.0/drivers/profile

driversAddDriverNotificationToken

object driversAddDriverNotificationToken($update_driver_token)

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\DriversApi(
    // 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
);
$update_driver_token = new \Flipdish\\Client\Models\UpdateDriverNotificationToken(); // \Flipdish\\Client\Models\UpdateDriverNotificationToken | 

try {
    $result = $apiInstance->driversAddDriverNotificationToken($update_driver_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DriversApi->driversAddDriverNotificationToken: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
update_driver_token	\Flipdish\Client\Models\UpdateDriverNotificationToken

Return type

object

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]

driversDeleteDriverProfileImage

object driversDeleteDriverProfileImage()

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\DriversApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

object

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]

driversDriverLogin

object driversDriverLogin($driver_login_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\DriversApi(
    // 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
);
$driver_login_model = new \Flipdish\\Client\Models\DriverLoginModel(); // \Flipdish\\Client\Models\DriverLoginModel | 

try {
    $result = $apiInstance->driversDriverLogin($driver_login_model);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DriversApi->driversDriverLogin: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
driver_login_model	\Flipdish\Client\Models\DriverLoginModel

Return type

object

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]

driversDriverRequestLoginCodeSms

object driversDriverRequestLoginCodeSms($driver_request_login_pin_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\DriversApi(
    // 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
);
$driver_request_login_pin_model = new \Flipdish\\Client\Models\DriverRequestLoginPinModel(); // \Flipdish\\Client\Models\DriverRequestLoginPinModel | 

try {
    $result = $apiInstance->driversDriverRequestLoginCodeSms($driver_request_login_pin_model);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DriversApi->driversDriverRequestLoginCodeSms: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
driver_request_login_pin_model	\Flipdish\Client\Models\DriverRequestLoginPinModel

Return type

object

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]

driversGetDriverProfile

object driversGetDriverProfile()

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\DriversApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

object

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]

driversGetStoresForDriver

object driversGetStoresForDriver()

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\DriversApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

object

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]

driversRemoveDriverNotificationToken

object driversRemoveDriverNotificationToken($remove_driver_token)

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\DriversApi(
    // 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
);
$remove_driver_token = new \Flipdish\\Client\Models\UpdateDriverNotificationToken(); // \Flipdish\\Client\Models\UpdateDriverNotificationToken | 

try {
    $result = $apiInstance->driversRemoveDriverNotificationToken($remove_driver_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DriversApi->driversRemoveDriverNotificationToken: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
remove_driver_token	\Flipdish\Client\Models\UpdateDriverNotificationToken

Return type

object

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]

driversSetDriverPresenceForStore

object driversSetDriverPresenceForStore($store_id, $presence)

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\DriversApi(
    // 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
);
$store_id = 56; // int | 
$presence = "presence_example"; // string | 

try {
    $result = $apiInstance->driversSetDriverPresenceForStore($store_id, $presence);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DriversApi->driversSetDriverPresenceForStore: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
store_id	int
presence	string

Return type

object

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]

driversSetDriverProfileImage

object driversSetDriverProfileImage()

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\DriversApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

object

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]

driversUpdateDeliveryTrackingStatus

object driversUpdateDeliveryTrackingStatus($order_id, $delivery_tracking_status)

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\DriversApi(
    // 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
);
$order_id = 56; // int | 
$delivery_tracking_status = "delivery_tracking_status_example"; // string | 

try {
    $result = $apiInstance->driversUpdateDeliveryTrackingStatus($order_id, $delivery_tracking_status);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DriversApi->driversUpdateDeliveryTrackingStatus: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
order_id	int
delivery_tracking_status	string

Return type

object

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]

driversUpdateDriverProfile

object driversUpdateDriverProfile($update_driver_profile)

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\DriversApi(
    // 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
);
$update_driver_profile = new \Flipdish\\Client\Models\UpdateDriverProfileModel(); // \Flipdish\\Client\Models\UpdateDriverProfileModel | 

try {
    $result = $apiInstance->driversUpdateDriverProfile($update_driver_profile);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DriversApi->driversUpdateDriverProfile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
update_driver_profile	\Flipdish\Client\Models\UpdateDriverProfileModel

Return type

object

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]

FilesExpand file tree

DriversApi.md

Latest commit

History

DriversApi.md

File metadata and controls

Flipdish\Client\DriversApi

driversAddDriverNotificationToken

Example

Parameters

Return type

Authorization

HTTP request headers

driversDeleteDriverProfileImage

Example

Parameters

Return type

Authorization

HTTP request headers

driversDriverLogin

Example

Parameters

Return type

Authorization

HTTP request headers

driversDriverRequestLoginCodeSms

Example

Parameters

Return type

Authorization

HTTP request headers

driversGetDriverProfile

Example

Parameters

Return type

Authorization

HTTP request headers

driversGetStoresForDriver

Example

Parameters

Return type

Authorization

HTTP request headers

driversRemoveDriverNotificationToken

Example

Parameters

Return type

Authorization

HTTP request headers

driversSetDriverPresenceForStore

Example

Parameters

Return type

Authorization

HTTP request headers

driversSetDriverProfileImage

Example

Parameters

Return type

Authorization

HTTP request headers

driversUpdateDeliveryTrackingStatus

Example

Parameters

Return type

Authorization

HTTP request headers

driversUpdateDriverProfile

Example

Parameters

Return type

Authorization

HTTP request headers