Skip to content

Latest commit

 

History

History
410 lines (310 loc) · 13.2 KB

MetafieldDefinitionsApi.md

File metadata and controls

410 lines (310 loc) · 13.2 KB

Flipdish.Api.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 (string appId, string ownerEntity, CreateMetafieldDefinition createMetafieldDefinition)

Example

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

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

            var apiInstance = new MetafieldDefinitionsApi();
            var appId = appId_example;  // string | 
            var ownerEntity = ownerEntity_example;  // string | 
            var createMetafieldDefinition = new CreateMetafieldDefinition(); // CreateMetafieldDefinition | 

            try
            {
                RestApiResultMetafieldDefinition result = apiInstance.CreateMetafieldDefinition(appId, ownerEntity, createMetafieldDefinition);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetafieldDefinitionsApi.CreateMetafieldDefinition: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMetafieldDefinitionByKey

RestApiResultMetafieldDefinition GetMetafieldDefinitionByKey (string appId, string ownerEntity, string key)

Example

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

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

            var apiInstance = new MetafieldDefinitionsApi();
            var appId = appId_example;  // string | 
            var ownerEntity = ownerEntity_example;  // string | 
            var key = key_example;  // string | 

            try
            {
                RestApiResultMetafieldDefinition result = apiInstance.GetMetafieldDefinitionByKey(appId, ownerEntity, key);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetafieldDefinitionsApi.GetMetafieldDefinitionByKey: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMetafieldDefinitions

RestApiPaginationResultMetafieldDefinition GetMetafieldDefinitions (string appId, string ownerEntity, string searchTerm = null, int? page = null, int? limit = null)

Example

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

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

            var apiInstance = new MetafieldDefinitionsApi();
            var appId = appId_example;  // string | 
            var ownerEntity = ownerEntity_example;  // string | 
            var searchTerm = searchTerm_example;  // string |  (optional) 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 

            try
            {
                RestApiPaginationResultMetafieldDefinition result = apiInstance.GetMetafieldDefinitions(appId, ownerEntity, searchTerm, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetafieldDefinitionsApi.GetMetafieldDefinitions: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
ownerEntity string
searchTerm string [optional]
page int? [optional]
limit int? [optional]

Return type

RestApiPaginationResultMetafieldDefinition

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]

GetOwnerEntityConfigurations

OwnerEntityConfigurations GetOwnerEntityConfigurations (string appId)

Example

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

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

            var apiInstance = new MetafieldDefinitionsApi();
            var appId = appId_example;  // string | 

            try
            {
                OwnerEntityConfigurations result = apiInstance.GetOwnerEntityConfigurations(appId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetafieldDefinitionsApi.GetOwnerEntityConfigurations: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetOwnerEntityRecommendations

RestApiPaginationResultMetafieldDefinitionRecommendation GetOwnerEntityRecommendations (string appId, string ownerEntity, string searchTerm = null, int? page = null, int? limit = null)

Example

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

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

            var apiInstance = new MetafieldDefinitionsApi();
            var appId = appId_example;  // string | 
            var ownerEntity = ownerEntity_example;  // string | 
            var searchTerm = searchTerm_example;  // string |  (optional) 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 

            try
            {
                RestApiPaginationResultMetafieldDefinitionRecommendation result = apiInstance.GetOwnerEntityRecommendations(appId, ownerEntity, searchTerm, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetafieldDefinitionsApi.GetOwnerEntityRecommendations: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
ownerEntity string
searchTerm string [optional]
page int? [optional]
limit int? [optional]

Return type

RestApiPaginationResultMetafieldDefinitionRecommendation

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]

UpdateMetafieldDefinition

RestApiResultMetafieldDefinition UpdateMetafieldDefinition (string appId, string ownerEntity, string key, UpdateMetafieldDefinition updateMetafieldDefinition)

Example

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

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

            var apiInstance = new MetafieldDefinitionsApi();
            var appId = appId_example;  // string | 
            var ownerEntity = ownerEntity_example;  // string | 
            var key = key_example;  // string | 
            var updateMetafieldDefinition = new UpdateMetafieldDefinition(); // UpdateMetafieldDefinition | 

            try
            {
                RestApiResultMetafieldDefinition result = apiInstance.UpdateMetafieldDefinition(appId, ownerEntity, key, updateMetafieldDefinition);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetafieldDefinitionsApi.UpdateMetafieldDefinition: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]