Skip to content

Latest commit

 

History

History
1011 lines (719 loc) · 34.9 KB

DirectorsApi.md

File metadata and controls

1011 lines (719 loc) · 34.9 KB

DirectorsApi

All URIs are relative to https://api.kinow.com/api

Method HTTP request Description
attachDirectorToCategory POST /categories/{category_id}/directors
attachDirectorToProduct POST /products/{product_id}/directors
attachFeaturesToDirector POST /directors/{director_id}/features
createDirector POST /directors
deleteDirector DELETE /directors/{director_id}
detachDirectorFromCategory DELETE /categories/{category_id}/directors/{director_id}
detachDirectorFromProduct DELETE /products/{product_id}/directors/{director_id}
getCategoryDirectors GET /categories/{category_id}/directors
getDirector GET /directors/{director_id}
getDirectorCoverImage GET /directors/{director_id}/cover
getDirectorFeatures GET /directors/{director_id}/features
getDirectorProducts GET /directors/{director_id}/products
getDirectorProductsRole GET /directors/{director_id}/products-role
getDirectors GET /directors
getProductDirectors GET /products/{product_id}/directors
getProductDirectorsRole GET /products/{product_id}/directors-role
updateDirector PUT /directors/{director_id}
uploadDirectorCover POST /directors/{director_id}/cover

attachDirectorToCategory

attachDirectorToCategory($category_id, $director_id)

Attach director to category

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\DirectorsApi();
$category_id = 789; // int | Category ID to fetch
$director_id = 789; // int | Director ID to attach

try {
    $api_instance->attachDirectorToCategory($category_id, $director_id);
} catch (Exception $e) {
    echo 'Exception when calling DirectorsApi->attachDirectorToCategory: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
category_id int Category ID to fetch
director_id int Director ID to attach

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

attachDirectorToProduct

attachDirectorToProduct($product_id, $director_id)

Attach director to product

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\DirectorsApi();
$product_id = 789; // int | Product ID to fetch
$director_id = 789; // int | Director ID to attach

try {
    $api_instance->attachDirectorToProduct($product_id, $director_id);
} catch (Exception $e) {
    echo 'Exception when calling DirectorsApi->attachDirectorToProduct: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
product_id int Product ID to fetch
director_id int Director ID to attach

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

attachFeaturesToDirector

attachFeaturesToDirector($director_id, $features)

Attach feature to director

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\DirectorsApi();
$director_id = 789; // int | 
$features = "features_example"; // string | To attach existing FeatureValue to director:     ```     [{     \"id_feature\":3,     \"id_feature_value\":5     }]     ```      To create a custom FeatureValue:     ```     [{     \"id_feature\":3,     \"custom_value\":[{     \"lang\": 1,     \"value\": \"string\"     }]     }]     ```

try {
    $api_instance->attachFeaturesToDirector($director_id, $features);
} catch (Exception $e) {
    echo 'Exception when calling DirectorsApi->attachFeaturesToDirector: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
director_id int
features string To attach existing FeatureValue to director: ``` [{ &quot;id_feature&quot;:3, &quot;id_feature_value&quot;:5 }] ``` To create a custom FeatureValue: ``` [{ &quot;id_feature&quot;:3, &quot;custom_value&quot;:[{ &quot;lang&quot;: 1, &quot;value&quot;: &quot;string&quot; }] }] ```

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

createDirector

\Kinow\Client\Model\Director createDirector($body)

Create new director

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\DirectorsApi();
$body = new \Kinow\Client\Model\CreateDirectorRequest(); // \Kinow\Client\Model\CreateDirectorRequest | Directory settings

try {
    $result = $api_instance->createDirector($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DirectorsApi->createDirector: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Kinow\Client\Model\CreateDirectorRequest Directory settings

Return type

\Kinow\Client\Model\Director

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

deleteDirector

deleteDirector($director_id)

Delete director

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\DirectorsApi();
$director_id = 56; // int | 

try {
    $api_instance->deleteDirector($director_id);
} catch (Exception $e) {
    echo 'Exception when calling DirectorsApi->deleteDirector: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
director_id int

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

detachDirectorFromCategory

detachDirectorFromCategory($category_id, $director_id)

Detach director from category

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\DirectorsApi();
$category_id = 789; // int | Category ID to fetch
$director_id = 789; // int | Director ID to detach

try {
    $api_instance->detachDirectorFromCategory($category_id, $director_id);
} catch (Exception $e) {
    echo 'Exception when calling DirectorsApi->detachDirectorFromCategory: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
category_id int Category ID to fetch
director_id int Director ID to detach

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

detachDirectorFromProduct

detachDirectorFromProduct($product_id, $director_id)

Detach director from product

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\DirectorsApi();
$product_id = 789; // int | Product ID to fetch
$director_id = 789; // int | Director ID to detach

try {
    $api_instance->detachDirectorFromProduct($product_id, $director_id);
} catch (Exception $e) {
    echo 'Exception when calling DirectorsApi->detachDirectorFromProduct: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
product_id int Product ID to fetch
director_id int Director ID to detach

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getCategoryDirectors

\Kinow\Client\Model\CategoryDirectorsListResponse getCategoryDirectors($category_id, $page, $per_page)

Get directors attached to category

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\DirectorsApi();
$category_id = 789; // int | Category ID to fetch
$page = 789; // int | 
$per_page = 789; // int | 

try {
    $result = $api_instance->getCategoryDirectors($category_id, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DirectorsApi->getCategoryDirectors: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
category_id int Category ID to fetch
page int [optional]
per_page int [optional]

Return type

\Kinow\Client\Model\CategoryDirectorsListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getDirector

\Kinow\Client\Model\DirectorResponse getDirector($director_id)

Get Director

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\DirectorsApi();
$director_id = 789; // int | Director ID to fetch

try {
    $result = $api_instance->getDirector($director_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DirectorsApi->getDirector: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
director_id int Director ID to fetch

Return type

\Kinow\Client\Model\DirectorResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getDirectorCoverImage

\Kinow\Client\Model\ImageResponse getDirectorCoverImage($director_id)

Get cover image of a director

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\DirectorsApi();
$director_id = 789; // int | Director ID to fetch

try {
    $result = $api_instance->getDirectorCoverImage($director_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DirectorsApi->getDirectorCoverImage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
director_id int Director ID to fetch

Return type

\Kinow\Client\Model\ImageResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getDirectorFeatures

\Kinow\Client\Model\FeatureListResponse getDirectorFeatures($director_id, $page, $per_page)

Get director features

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\DirectorsApi();
$director_id = 789; // int | Director ID to fetch
$page = 789; // int | 
$per_page = 789; // int | 

try {
    $result = $api_instance->getDirectorFeatures($director_id, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DirectorsApi->getDirectorFeatures: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
director_id int Director ID to fetch
page int [optional]
per_page int [optional]

Return type

\Kinow\Client\Model\FeatureListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getDirectorProducts

\Kinow\Client\Model\DirectorProductListResponse getDirectorProducts($director_id, $page, $per_page, $sort_by, $sort_direction, $ip, $features, $filters)

Get director products

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\DirectorsApi();
$director_id = 789; // int | Director ID to fetch
$page = 789; // int | 
$per_page = 789; // int | 
$sort_by = "sort_by_example"; // string | Sort by this attribute (id by default)
$sort_direction = "sort_direction_example"; // string | Sorting direction (asc by default)
$ip = "ip_example"; // string | Filter by user IP
$features = "features_example"; // string | ``` features[*][value]=string&features[*][operator]=strict&features[1][value]=string&features[1][operator]=strict _______________  { \"*\": { \"value\": \"string\", \"operator\": \"strict\" }, \"1\": { \"value\": \"string\", \"operator\": \"contains\" } } ``` Operator can be: strict, contains, between, in, gt (greater than), lt (lower than). To search on all features, you can pass * as featureId.
$filters = "filters_example"; // string | ``` name[value]=string&name[operator]=contains&date_add[value]=string&date_add[operator]=lt _______________  { \"name\": { \"value\": \"string\", \"operator\": \"contains\" }, \"date_add\": { \"value\": \"string\", \"operator\": \"lt\" } } ``` Operator can be: strict, contains, between, in, gt (greater than), lt (lower than).

try {
    $result = $api_instance->getDirectorProducts($director_id, $page, $per_page, $sort_by, $sort_direction, $ip, $features, $filters);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DirectorsApi->getDirectorProducts: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
director_id int Director ID to fetch
page int [optional]
per_page int [optional]
sort_by string Sort by this attribute (id by default) [optional]
sort_direction string Sorting direction (asc by default) [optional]
ip string Filter by user IP [optional]
features string ``` features[][value]=string&features[][operator]=strict&features[1][value]=string&features[1][operator]=strict _______________ { &quot;*&quot;: { &quot;value&quot;: &quot;string&quot;, &quot;operator&quot;: &quot;strict&quot; }, &quot;1&quot;: { &quot;value&quot;: &quot;string&quot;, &quot;operator&quot;: &quot;contains&quot; } } ``` Operator can be: strict, contains, between, in, gt (greater than), lt (lower than). To search on all features, you can pass * as featureId. [optional]
filters string ``` name[value]=string&name[operator]=contains&date_add[value]=string&date_add[operator]=lt _______________ { &quot;name&quot;: { &quot;value&quot;: &quot;string&quot;, &quot;operator&quot;: &quot;contains&quot; }, &quot;date_add&quot;: { &quot;value&quot;: &quot;string&quot;, &quot;operator&quot;: &quot;lt&quot; } } ``` Operator can be: strict, contains, between, in, gt (greater than), lt (lower than). [optional]

Return type

\Kinow\Client\Model\DirectorProductListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getDirectorProductsRole

\Kinow\Client\Model\DirectorProductRoleListResponse getDirectorProductsRole($director_id, $page, $per_page)

Get Products linked to Product with their role

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\DirectorsApi();
$director_id = 789; // int | Director ID to fetch
$page = 789; // int | 
$per_page = 789; // int | 

try {
    $result = $api_instance->getDirectorProductsRole($director_id, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DirectorsApi->getDirectorProductsRole: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
director_id int Director ID to fetch
page int [optional]
per_page int [optional]

Return type

\Kinow\Client\Model\DirectorProductRoleListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getDirectors

\Kinow\Client\Model\DirectorListResponse getDirectors($page, $per_page)

Get directors list

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\DirectorsApi();
$page = 789; // int | 
$per_page = 789; // int | 

try {
    $result = $api_instance->getDirectors($page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DirectorsApi->getDirectors: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
page int [optional]
per_page int [optional]

Return type

\Kinow\Client\Model\DirectorListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getProductDirectors

\Kinow\Client\Model\DirectorListResponse getProductDirectors($product_id, $page, $per_page, $image_type)

Get directors of a product

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\DirectorsApi();
$product_id = 789; // int | Product ID to fetch
$page = 789; // int | 
$per_page = 789; // int | 
$image_type = "image_type_example"; // string | 

try {
    $result = $api_instance->getProductDirectors($product_id, $page, $per_page, $image_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DirectorsApi->getProductDirectors: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
product_id int Product ID to fetch
page int [optional]
per_page int [optional]
image_type string [optional]

Return type

\Kinow\Client\Model\DirectorListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getProductDirectorsRole

\Kinow\Client\Model\DirectorRoleListResponse getProductDirectorsRole($product_id, $page, $per_page)

Get Directors attached to Product with their role

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\DirectorsApi();
$product_id = 789; // int | Product ID to fetch
$page = 789; // int | 
$per_page = 789; // int | 

try {
    $result = $api_instance->getProductDirectorsRole($product_id, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DirectorsApi->getProductDirectorsRole: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
product_id int Product ID to fetch
page int [optional]
per_page int [optional]

Return type

\Kinow\Client\Model\DirectorRoleListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

updateDirector

updateDirector($director_id, $body)

Update director

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\DirectorsApi();
$director_id = 56; // int | 
$body = new \Kinow\Client\Model\UpdateDirectorRequest(); // \Kinow\Client\Model\UpdateDirectorRequest | Directory settings

try {
    $api_instance->updateDirector($director_id, $body);
} catch (Exception $e) {
    echo 'Exception when calling DirectorsApi->updateDirector: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
director_id int
body \Kinow\Client\Model\UpdateDirectorRequest Directory settings

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

uploadDirectorCover

\Kinow\Client\Model\ImageResponse uploadDirectorCover($director_id, $file, $hash, $hash_algorithm)

Upload director cover

Example

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

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\DirectorsApi();
$director_id = 3.4; // float | Director ID to fetch
$file = "/path/to/file.txt"; // \SplFileObject | 
$hash = "hash_example"; // string | 
$hash_algorithm = "hash_algorithm_example"; // string | Hash algorithm to check the hash file (default value is: sha256)

try {
    $result = $api_instance->uploadDirectorCover($director_id, $file, $hash, $hash_algorithm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DirectorsApi->uploadDirectorCover: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
director_id float Director ID to fetch
file \SplFileObject [optional]
hash string [optional]
hash_algorithm string Hash algorithm to check the hash file (default value is: sha256) [optional]

Return type

\Kinow\Client\Model\ImageResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: Not defined