Skip to content

MetafieldDefinitionsApi.md

Latest commit

 

History

History
330 lines (224 loc) · 9.83 KB

MetafieldDefinitionsApi.md

File metadata and controls

330 lines (224 loc) · 9.83 KB
Raw

Flipdish.MetafieldDefinitionsApi

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

Method HTTP request Description
createMetafieldDefinition POST /api/v1.0/{appId}/metafields/definitions/{ownerEntity}
getMetafieldDefinitionByKey GET /api/v1.0/{appId}/metafields/definitions/{ownerEntity}/{key}
getMetafieldDefinitions GET /api/v1.0/{appId}/metafields/definitions/{ownerEntity}
getOwnerEntityConfigurations GET /api/v1.0/{appId}/metafields/definitions
getOwnerEntityRecommendations GET /api/v1.0/{appId}/metafields/definitions/recommendations/{ownerEntity}
updateMetafieldDefinition POST /api/v1.0/{appId}/metafields/definitions/{ownerEntity}/{key}

createMetafieldDefinition

RestApiResultMetafieldDefinition createMetafieldDefinition(appId, ownerEntity, createMetafieldDefinition)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.MetafieldDefinitionsApi();
let appId = "appId_example"; // String | 
let ownerEntity = "ownerEntity_example"; // String | 
let createMetafieldDefinition = new Flipdish.CreateMetafieldDefinition(); // CreateMetafieldDefinition | 
apiInstance.createMetafieldDefinition(appId, ownerEntity, createMetafieldDefinition, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
ownerEntity String
createMetafieldDefinition CreateMetafieldDefinition

Return type

RestApiResultMetafieldDefinition

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, IsReadOnly, OwnerEntity, Key, ValueType, Name, Description, Behaviors

getMetafieldDefinitionByKey

RestApiResultMetafieldDefinition getMetafieldDefinitionByKey(appId, ownerEntity, key)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.MetafieldDefinitionsApi();
let appId = "appId_example"; // String | 
let ownerEntity = "ownerEntity_example"; // String | 
let key = "key_example"; // String | 
apiInstance.getMetafieldDefinitionByKey(appId, ownerEntity, key, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
ownerEntity String
key String

Return type

RestApiResultMetafieldDefinition

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, IsReadOnly, OwnerEntity, Key, ValueType, Name, Description, Behaviors

getMetafieldDefinitions

RestApiPaginationResultMetafieldDefinition getMetafieldDefinitions(appId, ownerEntity, opts)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.MetafieldDefinitionsApi();
let appId = "appId_example"; // String | 
let ownerEntity = "ownerEntity_example"; // String | 
let opts = {
  'searchTerm': "searchTerm_example", // String | 
  'page': 56, // Number | 
  'limit': 56 // Number | 
};
apiInstance.getMetafieldDefinitions(appId, ownerEntity, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
ownerEntity String
searchTerm String [optional]
page Number [optional]
limit Number [optional]

Return type

RestApiPaginationResultMetafieldDefinition

Authorization

oauth2

HTTP request headers

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

getOwnerEntityConfigurations

OwnerEntityConfigurations getOwnerEntityConfigurations(appId)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.MetafieldDefinitionsApi();
let appId = "appId_example"; // String | 
apiInstance.getOwnerEntityConfigurations(appId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String

Return type

OwnerEntityConfigurations

Authorization

oauth2

HTTP request headers

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

getOwnerEntityRecommendations

RestApiPaginationResultMetafieldDefinitionRecommendation getOwnerEntityRecommendations(appId, ownerEntity, opts)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.MetafieldDefinitionsApi();
let appId = "appId_example"; // String | 
let ownerEntity = "ownerEntity_example"; // String | 
let opts = {
  'searchTerm': "searchTerm_example", // String | 
  'page': 56, // Number | 
  'limit': 56 // Number | 
};
apiInstance.getOwnerEntityRecommendations(appId, ownerEntity, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
ownerEntity String
searchTerm String [optional]
page Number [optional]
limit Number [optional]

Return type

RestApiPaginationResultMetafieldDefinitionRecommendation

Authorization

oauth2

HTTP request headers

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

updateMetafieldDefinition

RestApiResultMetafieldDefinition updateMetafieldDefinition(appId, ownerEntity, key, updateMetafieldDefinition)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.MetafieldDefinitionsApi();
let appId = "appId_example"; // String | 
let ownerEntity = "ownerEntity_example"; // String | 
let key = "key_example"; // String | 
let updateMetafieldDefinition = new Flipdish.UpdateMetafieldDefinition(); // UpdateMetafieldDefinition | 
apiInstance.updateMetafieldDefinition(appId, ownerEntity, key, updateMetafieldDefinition, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
ownerEntity String
key String
updateMetafieldDefinition UpdateMetafieldDefinition

Return type

RestApiResultMetafieldDefinition

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, IsReadOnly, OwnerEntity, Key, ValueType, Name, Description, Behaviors