Skip to content

Latest commit

 

History

History
415 lines (315 loc) · 12.2 KB

CatalogItemsApi.md

File metadata and controls

415 lines (315 loc) · 12.2 KB

Flipdish.Api.CatalogItemsApi

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

Method HTTP request Description
ArchiveCatalogItem POST /api/v1.0/{appId}/catalog/items/{catalogItemId}/archive Archive Catalog Item
CreateCatalogItem POST /api/v1.0/{appId}/catalog/items Create a Catalog Item
DuplicateCatalogItem POST /api/v1.0/{appId}/catalog/items/{catalogItemId}/duplicate Duplicate Catalog Item
GetCatalogItemById GET /api/v1.0/{appId}/catalog/items/{catalogItemId} Get item by Id
GetItems GET /api/v1.0/{appId}/catalog/items Get paginated items by app name id filtered by types
UpdateCatalogItem POST /api/v1.0/{appId}/catalog/items/{catalogItemId} Update Catalog Item

ArchiveCatalogItem

void ArchiveCatalogItem (string appId, string catalogItemId)

Archive Catalog Item

[BETA - this endpoint is under development, do not use it in your production system]

Example

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

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

            var apiInstance = new CatalogItemsApi();
            var appId = appId_example;  // string | 
            var catalogItemId = catalogItemId_example;  // string | 

            try
            {
                // Archive Catalog Item
                apiInstance.ArchiveCatalogItem(appId, catalogItemId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogItemsApi.ArchiveCatalogItem: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
catalogItemId string

Return type

void (empty response body)

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]

CreateCatalogItem

RestApiResultCatalogItem CreateCatalogItem (string appId, CreateCatalogItem createCatalogItem)

Create a Catalog Item

[BETA - this endpoint is under development, do not use it in your production system]

Example

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

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

            var apiInstance = new CatalogItemsApi();
            var appId = appId_example;  // string | 
            var createCatalogItem = new CreateCatalogItem(); // CreateCatalogItem | 

            try
            {
                // Create a Catalog Item
                RestApiResultCatalogItem result = apiInstance.CreateCatalogItem(appId, createCatalogItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogItemsApi.CreateCatalogItem: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
createCatalogItem CreateCatalogItem

Return type

RestApiResultCatalogItem

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]

DuplicateCatalogItem

void DuplicateCatalogItem (string appId, string catalogItemId)

Duplicate Catalog Item

[BETA - this endpoint is under development, do not use it in your production system]

Example

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

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

            var apiInstance = new CatalogItemsApi();
            var appId = appId_example;  // string | 
            var catalogItemId = catalogItemId_example;  // string | 

            try
            {
                // Duplicate Catalog Item
                apiInstance.DuplicateCatalogItem(appId, catalogItemId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogItemsApi.DuplicateCatalogItem: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
catalogItemId string

Return type

void (empty response body)

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]

GetCatalogItemById

CatalogItem GetCatalogItemById (string appId, string catalogItemId)

Get item by Id

[BETA - this endpoint is under development, do not use it in your production system]

Example

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

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

            var apiInstance = new CatalogItemsApi();
            var appId = appId_example;  // string | 
            var catalogItemId = catalogItemId_example;  // string | 

            try
            {
                // Get item by Id
                CatalogItem result = apiInstance.GetCatalogItemById(appId, catalogItemId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogItemsApi.GetCatalogItemById: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
catalogItemId string

Return type

CatalogItem

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]

GetItems

RestApiPaginationResultCatalogItem GetItems (string appId, List itemTypes, string searchTerm = null, int? page = null, int? limit = null)

Get paginated items by app name id filtered by types

[BETA - this endpoint is under development, do not use it in your production system]

Example

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

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

            var apiInstance = new CatalogItemsApi();
            var appId = appId_example;  // string | 
            var itemTypes = itemTypes_example;  // List<string> | 
            var searchTerm = searchTerm_example;  // string |  (optional) 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 

            try
            {
                // Get paginated items by app name id filtered by types
                RestApiPaginationResultCatalogItem result = apiInstance.GetItems(appId, itemTypes, searchTerm, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogItemsApi.GetItems: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
itemTypes List<string>
searchTerm string [optional]
page int? [optional]
limit int? [optional]

Return type

RestApiPaginationResultCatalogItem

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]

UpdateCatalogItem

void UpdateCatalogItem (string appId, string catalogItemId, UpdateCatalogItem updateCatalogItem)

Update Catalog Item

[BETA - this endpoint is under development, do not use it in your production system]

Example

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

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

            var apiInstance = new CatalogItemsApi();
            var appId = appId_example;  // string | 
            var catalogItemId = catalogItemId_example;  // string | 
            var updateCatalogItem = new UpdateCatalogItem(); // UpdateCatalogItem | 

            try
            {
                // Update Catalog Item
                apiInstance.UpdateCatalogItem(appId, catalogItemId, updateCatalogItem);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogItemsApi.UpdateCatalogItem: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
catalogItemId string
updateCatalogItem UpdateCatalogItem

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]