Skip to content

Latest commit

 

History

History
349 lines (255 loc) · 10.5 KB

CatalogGroupsApi.md

File metadata and controls

349 lines (255 loc) · 10.5 KB

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

archiveGroup(appId, catalogItemId)

Archive Catalog Group

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

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CatalogGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CatalogGroupsApi apiInstance = new CatalogGroupsApi();
String appId = "appId_example"; // String | 
String catalogItemId = "catalogItemId_example"; // String | 
try {
    apiInstance.archiveGroup(appId, catalogItemId);
} catch (ApiException e) {
    System.err.println("Exception when calling CatalogGroupsApi#archiveGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
catalogItemId String

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

createGroup

RestApiResultGroup createGroup(appId, createGroup)

Create a Catalog Group

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

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CatalogGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CatalogGroupsApi apiInstance = new CatalogGroupsApi();
String appId = "appId_example"; // String | 
CreateGroup createGroup = new CreateGroup(); // CreateGroup | 
try {
    RestApiResultGroup result = apiInstance.createGroup(appId, createGroup);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CatalogGroupsApi#createGroup");
    e.printStackTrace();
}

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

duplicateGroup

duplicateGroup(appId, catalogItemId)

Duplicate Catalog Group

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

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CatalogGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CatalogGroupsApi apiInstance = new CatalogGroupsApi();
String appId = "appId_example"; // String | 
String catalogItemId = "catalogItemId_example"; // String | 
try {
    apiInstance.duplicateGroup(appId, catalogItemId);
} catch (ApiException e) {
    System.err.println("Exception when calling CatalogGroupsApi#duplicateGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
catalogItemId String

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getGroupById

Group getGroupById(appId, catalogItemId)

Get group by Id

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

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CatalogGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CatalogGroupsApi apiInstance = new CatalogGroupsApi();
String appId = "appId_example"; // String | 
String catalogItemId = "catalogItemId_example"; // String | 
try {
    Group result = apiInstance.getGroupById(appId, catalogItemId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CatalogGroupsApi#getGroupById");
    e.printStackTrace();
}

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

getGroups

RestApiPaginationResultGroup getGroups(appId, groupTypes, searchTerm, page, limit)

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

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CatalogGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CatalogGroupsApi apiInstance = new CatalogGroupsApi();
String appId = "appId_example"; // String | 
List<String> groupTypes = Arrays.asList("groupTypes_example"); // List<String> | 
String searchTerm = "searchTerm_example"; // String | 
Integer page = 56; // Integer | 
Integer limit = 56; // Integer | 
try {
    RestApiPaginationResultGroup result = apiInstance.getGroups(appId, groupTypes, searchTerm, page, limit);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CatalogGroupsApi#getGroups");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
groupTypes List<String> [enum: ModifierGroup]
searchTerm String [optional]
page Integer [optional]
limit Integer [optional]

Return type

RestApiPaginationResultGroup

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

updateGroup

updateGroup(appId, catalogItemId, updateGroup)

Update Catalog Group

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

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.CatalogGroupsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

CatalogGroupsApi apiInstance = new CatalogGroupsApi();
String appId = "appId_example"; // String | 
String catalogItemId = "catalogItemId_example"; // String | 
UpdateGroup updateGroup = new UpdateGroup(); // UpdateGroup | 
try {
    apiInstance.updateGroup(appId, catalogItemId, updateGroup);
} catch (ApiException e) {
    System.err.println("Exception when calling CatalogGroupsApi#updateGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
catalogItemId String
updateGroup UpdateGroup

Return type

null (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