Skip to content

CatalogGroupsApi.md

Latest commit

 

History

History
415 lines (315 loc) · 11.9 KB

CatalogGroupsApi.md

File metadata and controls

415 lines (315 loc) · 11.9 KB

Flipdish.Api.CatalogGroupsApi

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

Method HTTP request Description
ArchiveGroup POST /api/v1.0/{appId}/catalog/groups/{catalogItemId}/archive Archive Catalog Group
CreateGroup POST /api/v1.0/{appId}/catalog/groups Create a Catalog Group
DuplicateGroup POST /api/v1.0/{appId}/catalog/groups/{catalogItemId}/duplicate Duplicate Catalog Group
GetGroupById GET /api/v1.0/{appId}/catalog/groups/{catalogItemId} Get group by Id
GetGroups GET /api/v1.0/{appId}/catalog/groups Get paginated groups by app name id filtered by types
UpdateGroup POST /api/v1.0/{appId}/catalog/groups/{catalogItemId} Update Catalog Group

ArchiveGroup

void ArchiveGroup (string appId, string catalogItemId)

Archive Catalog Group

[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 ArchiveGroupExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

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

            try
            {
                // Archive Catalog Group
                apiInstance.ArchiveGroup(appId, catalogItemId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogGroupsApi.ArchiveGroup: " + 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]

CreateGroup

RestApiResultGroup CreateGroup (string appId, CreateGroup createGroup)

Create a Catalog Group

[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 CreateGroupExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CatalogGroupsApi();
            var appId = appId_example;  // string | 
            var createGroup = new CreateGroup(); // CreateGroup | 

            try
            {
                // Create a Catalog Group
                RestApiResultGroup result = apiInstance.CreateGroup(appId, createGroup);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogGroupsApi.CreateGroup: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
createGroup CreateGroup

Return type

RestApiResultGroup

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]

DuplicateGroup

void DuplicateGroup (string appId, string catalogItemId)

Duplicate Catalog Group

[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 DuplicateGroupExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

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

            try
            {
                // Duplicate Catalog Group
                apiInstance.DuplicateGroup(appId, catalogItemId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogGroupsApi.DuplicateGroup: " + 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]

GetGroupById

Group GetGroupById (string appId, string catalogItemId)

Get group 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 GetGroupByIdExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

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

            try
            {
                // Get group by Id
                Group result = apiInstance.GetGroupById(appId, catalogItemId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogGroupsApi.GetGroupById: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
catalogItemId string

Return type

Group

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]

GetGroups

RestApiPaginationResultGroup GetGroups (string appId, List groupTypes, string searchTerm = null, int? page = null, int? limit = null)

Get paginated groups 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 GetGroupsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CatalogGroupsApi();
            var appId = appId_example;  // string | 
            var groupTypes = groupTypes_example;  // List<string> | 
            var searchTerm = searchTerm_example;  // string |  (optional) 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 

            try
            {
                // Get paginated groups by app name id filtered by types
                RestApiPaginationResultGroup result = apiInstance.GetGroups(appId, groupTypes, searchTerm, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogGroupsApi.GetGroups: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

RestApiPaginationResultGroup

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]

UpdateGroup

void UpdateGroup (string appId, string catalogItemId, UpdateGroup updateGroup)

Update Catalog Group

[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 UpdateGroupExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CatalogGroupsApi();
            var appId = appId_example;  // string | 
            var catalogItemId = catalogItemId_example;  // string | 
            var updateGroup = new UpdateGroup(); // UpdateGroup | 

            try
            {
                // Update Catalog Group
                apiInstance.UpdateGroup(appId, catalogItemId, updateGroup);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogGroupsApi.UpdateGroup: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
catalogItemId string
updateGroup UpdateGroup

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]