Skip to content

Latest commit

 

History

History
530 lines (398 loc) · 15.6 KB

OnboardingApi.md

File metadata and controls

530 lines (398 loc) · 15.6 KB

Flipdish.Api.OnboardingApi

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

Method HTTP request Description
OnboardingGetOnboardingConfig GET /api/v1.0/clients/{appId}/onboarding/config
OnboardingGetOnboardingConfigs GET /api/v1.0/clients/{appId}/onboarding/configs
OnboardingGetOnboardingItems GET /api/v1.0/clients/{appId}/onboarding/stores/{storeId}
OnboardingGetOnboardingItemsV2 GET /api/v1.0/clients/{appId}/onboarding/stores
OnboardingUpdateOnboardingConfig POST /api/v1.0/clients/{appId}/onboarding/config
OnboardingUpdateOnboardingConfigById POST /api/v1.0/clients/{appId}/onboarding/config/{configId}
OnboardingUpdateOnboardingItem POST /api/v1.0/clients/{appId}/onboarding/stores/{storeId}/items/{onboardingItemId}
OnboardingUpdateOnboardingItemV2 POST /api/v1.0/clients/{appId}/onboarding/stores/items/{onboardingItemId}

OnboardingGetOnboardingConfig

Object OnboardingGetOnboardingConfig (string appId)

Example

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

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

            var apiInstance = new OnboardingApi();
            var appId = appId_example;  // string | 

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

Parameters

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

OnboardingGetOnboardingConfigs

Object OnboardingGetOnboardingConfigs (string appId)

Example

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

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

            var apiInstance = new OnboardingApi();
            var appId = appId_example;  // string | 

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

Parameters

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

OnboardingGetOnboardingItems

Object OnboardingGetOnboardingItems (string appId, int? storeId, int? milestoneId = null)

Example

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

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

            var apiInstance = new OnboardingApi();
            var appId = appId_example;  // string | 
            var storeId = 56;  // int? | 
            var milestoneId = 56;  // int? |  (optional) 

            try
            {
                Object result = apiInstance.OnboardingGetOnboardingItems(appId, storeId, milestoneId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OnboardingApi.OnboardingGetOnboardingItems: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
storeId int?
milestoneId int? [optional]

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]

OnboardingGetOnboardingItemsV2

Object OnboardingGetOnboardingItemsV2 (string appId, int? storeId = null, int? milestoneId = null)

Example

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

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

            var apiInstance = new OnboardingApi();
            var appId = appId_example;  // string | 
            var storeId = 56;  // int? |  (optional) 
            var milestoneId = 56;  // int? |  (optional) 

            try
            {
                Object result = apiInstance.OnboardingGetOnboardingItemsV2(appId, storeId, milestoneId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OnboardingApi.OnboardingGetOnboardingItemsV2: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
storeId int? [optional]
milestoneId int? [optional]

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]

OnboardingUpdateOnboardingConfig

Object OnboardingUpdateOnboardingConfig (string appId, OnboardingConfigUpdate configUpdate)

Example

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

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

            var apiInstance = new OnboardingApi();
            var appId = appId_example;  // string | 
            var configUpdate = new OnboardingConfigUpdate(); // OnboardingConfigUpdate | 

            try
            {
                Object result = apiInstance.OnboardingUpdateOnboardingConfig(appId, configUpdate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OnboardingApi.OnboardingUpdateOnboardingConfig: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
configUpdate OnboardingConfigUpdate

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]

OnboardingUpdateOnboardingConfigById

Object OnboardingUpdateOnboardingConfigById (string appId, int? configId, OnboardingConfigUpdate configUpdate)

Example

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

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

            var apiInstance = new OnboardingApi();
            var appId = appId_example;  // string | 
            var configId = 56;  // int? | 
            var configUpdate = new OnboardingConfigUpdate(); // OnboardingConfigUpdate | 

            try
            {
                Object result = apiInstance.OnboardingUpdateOnboardingConfigById(appId, configId, configUpdate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OnboardingApi.OnboardingUpdateOnboardingConfigById: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
configId int?
configUpdate OnboardingConfigUpdate

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]

OnboardingUpdateOnboardingItem

Object OnboardingUpdateOnboardingItem (string appId, int? storeId, int? onboardingItemId, OnboardingItemUpdate itemUpdate)

Example

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

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

            var apiInstance = new OnboardingApi();
            var appId = appId_example;  // string | 
            var storeId = 56;  // int? | 
            var onboardingItemId = 56;  // int? | 
            var itemUpdate = new OnboardingItemUpdate(); // OnboardingItemUpdate | 

            try
            {
                Object result = apiInstance.OnboardingUpdateOnboardingItem(appId, storeId, onboardingItemId, itemUpdate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OnboardingApi.OnboardingUpdateOnboardingItem: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
storeId int?
onboardingItemId int?
itemUpdate OnboardingItemUpdate

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]

OnboardingUpdateOnboardingItemV2

Object OnboardingUpdateOnboardingItemV2 (string appId, int? onboardingItemId, OnboardingItemUpdate itemUpdate, int? storeId = null)

Example

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

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

            var apiInstance = new OnboardingApi();
            var appId = appId_example;  // string | 
            var onboardingItemId = 56;  // int? | 
            var itemUpdate = new OnboardingItemUpdate(); // OnboardingItemUpdate | 
            var storeId = 56;  // int? |  (optional) 

            try
            {
                Object result = apiInstance.OnboardingUpdateOnboardingItemV2(appId, onboardingItemId, itemUpdate, storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OnboardingApi.OnboardingUpdateOnboardingItemV2: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
onboardingItemId int?
itemUpdate OnboardingItemUpdate
storeId int? [optional]

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]