Skip to content

CustomersApi.md

Latest commit

 

History

History
266 lines (198 loc) · 7.4 KB

CustomersApi.md

File metadata and controls

266 lines (198 loc) · 7.4 KB

Flipdish.Api.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 (string appId, CustomerCreateModel customerCreateModel)

Example

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

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

            var apiInstance = new CustomersApi();
            var appId = appId_example;  // string | 
            var customerCreateModel = new CustomerCreateModel(); // CustomerCreateModel | 

            try
            {
                RestApiResultCustomer result = apiInstance.CreateCustomer(appId, customerCreateModel);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomersApi.CreateCustomer: " + e.Message );
            }
        }
    }
}

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

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

GetCustomerById

RestApiResultCustomer GetCustomerById (string appId, int? customerId)

Example

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

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

            var apiInstance = new CustomersApi();
            var appId = appId_example;  // string | 
            var customerId = 56;  // int? | 

            try
            {
                RestApiResultCustomer result = apiInstance.GetCustomerById(appId, customerId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomersApi.GetCustomerById: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
customerId int?

Return type

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

RestApiResultCustomers GetCustomers (string appId, string phoneNumber)

Example

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

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

            var apiInstance = new CustomersApi();
            var appId = appId_example;  // string | 
            var phoneNumber = phoneNumber_example;  // string | 

            try
            {
                RestApiResultCustomers result = apiInstance.GetCustomers(appId, phoneNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomersApi.GetCustomers: " + e.Message );
            }
        }
    }
}

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

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

UpdateCustomerById

RestApiResultCustomer UpdateCustomerById (string appId, int? customerId, CustomerUpdateModel updateCustomer)

Example

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

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

            var apiInstance = new CustomersApi();
            var appId = appId_example;  // string | 
            var customerId = 56;  // int? | 
            var updateCustomer = new CustomerUpdateModel(); // CustomerUpdateModel | 

            try
            {
                RestApiResultCustomer result = apiInstance.UpdateCustomerById(appId, customerId, updateCustomer);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomersApi.UpdateCustomerById: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
customerId int?
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

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