Skip to content

Latest commit

 

History

History
678 lines (502 loc) · 18.7 KB

DriversApi.md

File metadata and controls

678 lines (502 loc) · 18.7 KB

Flipdish.Api.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 (UpdateDriverNotificationToken updateDriverToken)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class DriversAddDriverNotificationTokenExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DriversApi();
            var updateDriverToken = new UpdateDriverNotificationToken(); // UpdateDriverNotificationToken | 

            try
            {
                Object result = apiInstance.DriversAddDriverNotificationToken(updateDriverToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DriversApi.DriversAddDriverNotificationToken: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
updateDriverToken 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

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class DriversDeleteDriverProfileImageExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DriversApi();

            try
            {
                Object result = apiInstance.DriversDeleteDriverProfileImage();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DriversApi.DriversDeleteDriverProfileImage: " + e.Message );
            }
        }
    }
}

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 (DriverLoginModel driverLoginModel)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class DriversDriverLoginExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DriversApi();
            var driverLoginModel = new DriverLoginModel(); // DriverLoginModel | 

            try
            {
                Object result = apiInstance.DriversDriverLogin(driverLoginModel);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DriversApi.DriversDriverLogin: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
driverLoginModel 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 (DriverRequestLoginPinModel driverRequestLoginPinModel)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class DriversDriverRequestLoginCodeSmsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DriversApi();
            var driverRequestLoginPinModel = new DriverRequestLoginPinModel(); // DriverRequestLoginPinModel | 

            try
            {
                Object result = apiInstance.DriversDriverRequestLoginCodeSms(driverRequestLoginPinModel);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DriversApi.DriversDriverRequestLoginCodeSms: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
driverRequestLoginPinModel 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

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class DriversGetDriverProfileExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DriversApi();

            try
            {
                Object result = apiInstance.DriversGetDriverProfile();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DriversApi.DriversGetDriverProfile: " + e.Message );
            }
        }
    }
}

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

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class DriversGetStoresForDriverExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DriversApi();

            try
            {
                Object result = apiInstance.DriversGetStoresForDriver();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DriversApi.DriversGetStoresForDriver: " + e.Message );
            }
        }
    }
}

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 (UpdateDriverNotificationToken removeDriverToken)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class DriversRemoveDriverNotificationTokenExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DriversApi();
            var removeDriverToken = new UpdateDriverNotificationToken(); // UpdateDriverNotificationToken | 

            try
            {
                Object result = apiInstance.DriversRemoveDriverNotificationToken(removeDriverToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DriversApi.DriversRemoveDriverNotificationToken: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
removeDriverToken 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 (int? storeId, string presence)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class DriversSetDriverPresenceForStoreExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DriversApi();
            var storeId = 56;  // int? | 
            var presence = presence_example;  // string | 

            try
            {
                Object result = apiInstance.DriversSetDriverPresenceForStore(storeId, presence);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DriversApi.DriversSetDriverPresenceForStore: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId 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

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class DriversSetDriverProfileImageExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DriversApi();

            try
            {
                Object result = apiInstance.DriversSetDriverProfileImage();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DriversApi.DriversSetDriverProfileImage: " + e.Message );
            }
        }
    }
}

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 (int? orderId, string deliveryTrackingStatus)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class DriversUpdateDeliveryTrackingStatusExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DriversApi();
            var orderId = 56;  // int? | 
            var deliveryTrackingStatus = deliveryTrackingStatus_example;  // string | 

            try
            {
                Object result = apiInstance.DriversUpdateDeliveryTrackingStatus(orderId, deliveryTrackingStatus);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DriversApi.DriversUpdateDeliveryTrackingStatus: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
orderId int?
deliveryTrackingStatus 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 (UpdateDriverProfileModel updateDriverProfile)

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class DriversUpdateDriverProfileExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DriversApi();
            var updateDriverProfile = new UpdateDriverProfileModel(); // UpdateDriverProfileModel | 

            try
            {
                Object result = apiInstance.DriversUpdateDriverProfile(updateDriverProfile);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DriversApi.DriversUpdateDriverProfile: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
updateDriverProfile 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]