Skip to content

FulfillmentStateConfigurationApi.md

Latest commit

 

History

History
389 lines (289 loc) · 12.4 KB

FulfillmentStateConfigurationApi.md

File metadata and controls

389 lines (289 loc) · 12.4 KB

Flipdish.Api.FulfillmentStateConfigurationApi

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

Method HTTP request Description
CreateFulfillmentStatesConfig POST /api/v1.0/{appId}/fulfillment/configuration/states
DeleteFulfillmentStatesConfig DELETE /api/v1.0/{appId}/fulfillment/configuration/states/{configId}
GetFulfillmentStatesConfiguration GET /api/v1.0/{appId}/fulfillment/configuration/states/{configId}
GetFulfillmentStatesConfigurationTemplate GET /api/v1.0/{appId}/fulfillment/configuration/states_template
SearchFulfillmentStatesConfigurations GET /api/v1.0/{appId}/fulfillment/configuration/states
UpdateFulfillmentStatesConfig POST /api/v1.0/{appId}/fulfillment/configuration/states/{configId}

CreateFulfillmentStatesConfig

RestApiResultFulfillmentStatesConfiguration CreateFulfillmentStatesConfig (string appId, CreateFulfillmentStatesConfiguration fulfillmentStateConfiguration)

Example

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

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

            var apiInstance = new FulfillmentStateConfigurationApi();
            var appId = appId_example;  // string | 
            var fulfillmentStateConfiguration = new CreateFulfillmentStatesConfiguration(); // CreateFulfillmentStatesConfiguration | 

            try
            {
                RestApiResultFulfillmentStatesConfiguration result = apiInstance.CreateFulfillmentStatesConfig(appId, fulfillmentStateConfiguration);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FulfillmentStateConfigurationApi.CreateFulfillmentStatesConfig: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
fulfillmentStateConfiguration CreateFulfillmentStatesConfiguration

Return type

RestApiResultFulfillmentStatesConfiguration

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]

DeleteFulfillmentStatesConfig

RestApiStringResult DeleteFulfillmentStatesConfig (string appId, string configId)

Example

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

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

            var apiInstance = new FulfillmentStateConfigurationApi();
            var appId = appId_example;  // string | 
            var configId = configId_example;  // string | 

            try
            {
                RestApiStringResult result = apiInstance.DeleteFulfillmentStatesConfig(appId, configId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FulfillmentStateConfigurationApi.DeleteFulfillmentStatesConfig: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
configId string

Return type

RestApiStringResult

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]

GetFulfillmentStatesConfiguration

FulfillmentStatesConfiguration GetFulfillmentStatesConfiguration (string appId, string configId)

Example

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

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

            var apiInstance = new FulfillmentStateConfigurationApi();
            var appId = appId_example;  // string | 
            var configId = configId_example;  // string | 

            try
            {
                FulfillmentStatesConfiguration result = apiInstance.GetFulfillmentStatesConfiguration(appId, configId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FulfillmentStateConfigurationApi.GetFulfillmentStatesConfiguration: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
configId string

Return type

FulfillmentStatesConfiguration

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]

GetFulfillmentStatesConfigurationTemplate

FulfillmentStatesConfiguration GetFulfillmentStatesConfigurationTemplate (string appId)

Example

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

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

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

            try
            {
                FulfillmentStatesConfiguration result = apiInstance.GetFulfillmentStatesConfigurationTemplate(appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FulfillmentStateConfigurationApi.GetFulfillmentStatesConfigurationTemplate: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string

Return type

FulfillmentStatesConfiguration

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]

SearchFulfillmentStatesConfigurations

RestApiArrayResultFulfillmentStatesConfigurationSummary SearchFulfillmentStatesConfigurations (string appId)

Example

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

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

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

            try
            {
                RestApiArrayResultFulfillmentStatesConfigurationSummary result = apiInstance.SearchFulfillmentStatesConfigurations(appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FulfillmentStateConfigurationApi.SearchFulfillmentStatesConfigurations: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string

Return type

RestApiArrayResultFulfillmentStatesConfigurationSummary

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]

UpdateFulfillmentStatesConfig

void UpdateFulfillmentStatesConfig (string appId, string configId, UpdateFulfillmentStatesConfiguration updateFulfillmentStatesConfiguration)

Example

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

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

            var apiInstance = new FulfillmentStateConfigurationApi();
            var appId = appId_example;  // string | 
            var configId = configId_example;  // string | 
            var updateFulfillmentStatesConfiguration = new UpdateFulfillmentStatesConfiguration(); // UpdateFulfillmentStatesConfiguration | 

            try
            {
                apiInstance.UpdateFulfillmentStatesConfig(appId, configId, updateFulfillmentStatesConfiguration);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FulfillmentStateConfigurationApi.UpdateFulfillmentStatesConfig: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
configId string
updateFulfillmentStatesConfiguration UpdateFulfillmentStatesConfiguration

Return type

void (empty response body)

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]