Skip to content

Latest commit

 

History

History
350 lines (250 loc) · 12.6 KB

MetafieldDefinitionsApi.md

File metadata and controls

350 lines (250 loc) · 12.6 KB

Flipdish\Client\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

\Flipdish\Client\Models\RestApiResultMetafieldDefinition createMetafieldDefinition($app_id, $owner_entity, $create_metafield_definition)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MetafieldDefinitionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = "app_id_example"; // string | 
$owner_entity = "owner_entity_example"; // string | 
$create_metafield_definition = new \Flipdish\\Client\Models\CreateMetafieldDefinition(); // \Flipdish\\Client\Models\CreateMetafieldDefinition | 

try {
    $result = $apiInstance->createMetafieldDefinition($app_id, $owner_entity, $create_metafield_definition);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetafieldDefinitionsApi->createMetafieldDefinition: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
app_id string
owner_entity string
create_metafield_definition \Flipdish\Client\Models\CreateMetafieldDefinition

Return type

\Flipdish\Client\Models\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

\Flipdish\Client\Models\RestApiResultMetafieldDefinition getMetafieldDefinitionByKey($app_id, $owner_entity, $key)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MetafieldDefinitionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = "app_id_example"; // string | 
$owner_entity = "owner_entity_example"; // string | 
$key = "key_example"; // string | 

try {
    $result = $apiInstance->getMetafieldDefinitionByKey($app_id, $owner_entity, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetafieldDefinitionsApi->getMetafieldDefinitionByKey: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
app_id string
owner_entity string
key string

Return type

\Flipdish\Client\Models\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

\Flipdish\Client\Models\RestApiPaginationResultMetafieldDefinition getMetafieldDefinitions($app_id, $owner_entity, $search_term, $page, $limit)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MetafieldDefinitionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = "app_id_example"; // string | 
$owner_entity = "owner_entity_example"; // string | 
$search_term = "search_term_example"; // string | 
$page = 56; // int | 
$limit = 56; // int | 

try {
    $result = $apiInstance->getMetafieldDefinitions($app_id, $owner_entity, $search_term, $page, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetafieldDefinitionsApi->getMetafieldDefinitions: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
app_id string
owner_entity string
search_term string [optional]
page int [optional]
limit int [optional]

Return type

\Flipdish\Client\Models\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

\Flipdish\Client\Models\OwnerEntityConfigurations getOwnerEntityConfigurations($app_id)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MetafieldDefinitionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = "app_id_example"; // string | 

try {
    $result = $apiInstance->getOwnerEntityConfigurations($app_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetafieldDefinitionsApi->getOwnerEntityConfigurations: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
app_id string

Return type

\Flipdish\Client\Models\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

\Flipdish\Client\Models\RestApiPaginationResultMetafieldDefinitionRecommendation getOwnerEntityRecommendations($app_id, $owner_entity, $search_term, $page, $limit)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MetafieldDefinitionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = "app_id_example"; // string | 
$owner_entity = "owner_entity_example"; // string | 
$search_term = "search_term_example"; // string | 
$page = 56; // int | 
$limit = 56; // int | 

try {
    $result = $apiInstance->getOwnerEntityRecommendations($app_id, $owner_entity, $search_term, $page, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetafieldDefinitionsApi->getOwnerEntityRecommendations: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
app_id string
owner_entity string
search_term string [optional]
page int [optional]
limit int [optional]

Return type

\Flipdish\Client\Models\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

\Flipdish\Client\Models\RestApiResultMetafieldDefinition updateMetafieldDefinition($app_id, $owner_entity, $key, $update_metafield_definition)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\MetafieldDefinitionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = "app_id_example"; // string | 
$owner_entity = "owner_entity_example"; // string | 
$key = "key_example"; // string | 
$update_metafield_definition = new \Flipdish\\Client\Models\UpdateMetafieldDefinition(); // \Flipdish\\Client\Models\UpdateMetafieldDefinition | 

try {
    $result = $apiInstance->updateMetafieldDefinition($app_id, $owner_entity, $key, $update_metafield_definition);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetafieldDefinitionsApi->updateMetafieldDefinition: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
app_id string
owner_entity string
key string
update_metafield_definition \Flipdish\Client\Models\UpdateMetafieldDefinition

Return type

\Flipdish\Client\Models\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]