Skip to content

Latest commit

 

History

History
262 lines (194 loc) · 6.83 KB

StuartApi.md

File metadata and controls

262 lines (194 loc) · 6.83 KB

Flipdish.Api.StuartApi

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

Method HTTP request Description
StuartCancelJob DELETE /api/v1.0/stuart/jobs/{jobId}
StuartGetJob GET /api/v1.0/stuart/jobs/{jobId}
StuartGetStuartSettings GET /api/v1.0/stuart/settings/{storeId}
StuartPostStuartSettings POST /api/v1.0/stuart/settings/{storeId}

StuartCancelJob

Object StuartCancelJob (int? jobId, int? storeId)

Example

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

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

            var apiInstance = new StuartApi();
            var jobId = 56;  // int? | 
            var storeId = 56;  // int? | 

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

Parameters

Name Type Description Notes
jobId int?
storeId int?

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]

StuartGetJob

RestApiResultJobResponse StuartGetJob (int? jobId, int? storeId)

Example

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

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

            var apiInstance = new StuartApi();
            var jobId = 56;  // int? | 
            var storeId = 56;  // int? | 

            try
            {
                RestApiResultJobResponse result = apiInstance.StuartGetJob(jobId, storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StuartApi.StuartGetJob: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
jobId int?
storeId int?

Return type

RestApiResultJobResponse

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]

StuartGetStuartSettings

RestApiResultStuartSettings StuartGetStuartSettings (int? storeId)

Example

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

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

            var apiInstance = new StuartApi();
            var storeId = 56;  // int? | 

            try
            {
                RestApiResultStuartSettings result = apiInstance.StuartGetStuartSettings(storeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StuartApi.StuartGetStuartSettings: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
storeId int?

Return type

RestApiResultStuartSettings

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]

StuartPostStuartSettings

Object StuartPostStuartSettings (int? storeId, StuartSettings stuartSettings)

Example

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

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

            var apiInstance = new StuartApi();
            var storeId = 56;  // int? | 
            var stuartSettings = new StuartSettings(); // StuartSettings | 

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

Parameters

Name Type Description Notes
storeId int?
stuartSettings StuartSettings

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]