KinowJavascriptSdk.ActorsApi

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

Method	HTTP request	Description
attachActorToCategory	POST /categories/{category_id}/actors
attachActorToProduct	POST /products/{product_id}/actors
attachFeaturesToActor	POST /actors/{actor_id}/features
createActor	POST /actors
deleteActor	DELETE /actors/{actor_id}
detachActorFromCategory	DELETE /categories/{category_id}/actors/{actor_id}
detachActorFromProduct	DELETE /products/{product_id}/actors/{actor_id}
getActor	GET /actors/{actor_id}
getActorCoverImage	GET /actors/{actor_id}/cover
getActorFeatures	GET /actors/{actor_id}/features
getActorProducts	GET /actors/{actor_id}/products
getActorProductsRole	GET /actors/{actor_id}/products-role
getActors	GET /actors
getCategoryActors	GET /categories/{category_id}/actors
getProductActors	GET /products/{product_id}/actors
getProductActorsRole	GET /products/{product_id}/actors-role
updateActor	PUT /actors/{actor_id}
uploadActorCover	POST /actors/{actor_id}/cover

attachActorToCategory

attachActorToCategory(categoryId, actorId)

Attach actor to category

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');
var defaultClient = KinowJavascriptSdk.ApiClient.instance;

// Configure API key authorization: ApiClientId
var ApiClientId = defaultClient.authentications['ApiClientId'];
ApiClientId.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientId.apiKeyPrefix = 'Token';

// Configure API key authorization: ApiClientSecret
var ApiClientSecret = defaultClient.authentications['ApiClientSecret'];
ApiClientSecret.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientSecret.apiKeyPrefix = 'Token';

var apiInstance = new KinowJavascriptSdk.ActorsApi();

var categoryId = 789; // Integer | Category ID to fetch

var actorId = 789; // Integer | Actor ID to attach

apiInstance.attachActorToCategory(categoryId, actorId).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
categoryId	Integer	Category ID to fetch
actorId	Integer	Actor ID to attach

Return type

null (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

attachActorToProduct

attachActorToProduct(productId, actorId)

Attach actor to product

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');
var defaultClient = KinowJavascriptSdk.ApiClient.instance;

// Configure API key authorization: ApiClientId
var ApiClientId = defaultClient.authentications['ApiClientId'];
ApiClientId.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientId.apiKeyPrefix = 'Token';

// Configure API key authorization: ApiClientSecret
var ApiClientSecret = defaultClient.authentications['ApiClientSecret'];
ApiClientSecret.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientSecret.apiKeyPrefix = 'Token';

var apiInstance = new KinowJavascriptSdk.ActorsApi();

var productId = 789; // Integer | Product ID to fetch

var actorId = 789; // Integer | Actor ID to attach

apiInstance.attachActorToProduct(productId, actorId).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
productId	Integer	Product ID to fetch
actorId	Integer	Actor ID to attach

Return type

null (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

attachFeaturesToActor

attachFeaturesToActor(actorId, features)

Attach feature to actor

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');
var defaultClient = KinowJavascriptSdk.ApiClient.instance;

// Configure API key authorization: ApiClientId
var ApiClientId = defaultClient.authentications['ApiClientId'];
ApiClientId.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientId.apiKeyPrefix = 'Token';

// Configure API key authorization: ApiClientSecret
var ApiClientSecret = defaultClient.authentications['ApiClientSecret'];
ApiClientSecret.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientSecret.apiKeyPrefix = 'Token';

var apiInstance = new KinowJavascriptSdk.ActorsApi();

var actorId = 789; // Integer | 

var features = "features_example"; // String |      To attach existing FeatureValue to actor:     ```     [{     \"id_feature\":3,     \"id_feature_value\":5     }]     ```      To create a custom FeatureValue:     ```     [{     \"id_feature\":3,     \"custom_value\":[{     \"lang\": 1,     \"value\": \"string\"     }]     }]     ```

apiInstance.attachFeaturesToActor(actorId, features).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
actorId	Integer
features	String	To attach existing FeatureValue to actor: ``` [{ "id_feature":3, "id_feature_value":5 }] ``` To create a custom FeatureValue: ``` [{ "id_feature":3, "custom_value":[{ "lang": 1, "value": "string" }] }] ```

Return type

null (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

createActor

ActorResponse createActor(body)

Create new actor

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');
var defaultClient = KinowJavascriptSdk.ApiClient.instance;

// Configure API key authorization: ApiClientId
var ApiClientId = defaultClient.authentications['ApiClientId'];
ApiClientId.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientId.apiKeyPrefix = 'Token';

// Configure API key authorization: ApiClientSecret
var ApiClientSecret = defaultClient.authentications['ApiClientSecret'];
ApiClientSecret.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientSecret.apiKeyPrefix = 'Token';

var apiInstance = new KinowJavascriptSdk.ActorsApi();

var body = new KinowJavascriptSdk.CreateActorRequest(); // CreateActorRequest | Create an actor

apiInstance.createActor(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	CreateActorRequest	Create an actor

Return type

ActorResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

deleteActor

deleteActor(actorId)

Delete actor

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');
var defaultClient = KinowJavascriptSdk.ApiClient.instance;

// Configure API key authorization: ApiClientId
var ApiClientId = defaultClient.authentications['ApiClientId'];
ApiClientId.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientId.apiKeyPrefix = 'Token';

// Configure API key authorization: ApiClientSecret
var ApiClientSecret = defaultClient.authentications['ApiClientSecret'];
ApiClientSecret.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientSecret.apiKeyPrefix = 'Token';

var apiInstance = new KinowJavascriptSdk.ActorsApi();

var actorId = 56; // Integer | 

apiInstance.deleteActor(actorId).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
actorId	Integer

Return type

null (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

detachActorFromCategory

detachActorFromCategory(categoryId, actorId)

Detach actor from category

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');
var defaultClient = KinowJavascriptSdk.ApiClient.instance;

// Configure API key authorization: ApiClientId
var ApiClientId = defaultClient.authentications['ApiClientId'];
ApiClientId.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientId.apiKeyPrefix = 'Token';

// Configure API key authorization: ApiClientSecret
var ApiClientSecret = defaultClient.authentications['ApiClientSecret'];
ApiClientSecret.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientSecret.apiKeyPrefix = 'Token';

var apiInstance = new KinowJavascriptSdk.ActorsApi();

var categoryId = 789; // Integer | Category ID to fetch

var actorId = 789; // Integer | Actor ID to detach

apiInstance.detachActorFromCategory(categoryId, actorId).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
categoryId	Integer	Category ID to fetch
actorId	Integer	Actor ID to detach

Return type

null (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

detachActorFromProduct

detachActorFromProduct(productId, actorId)

Detach actor from product

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');
var defaultClient = KinowJavascriptSdk.ApiClient.instance;

// Configure API key authorization: ApiClientId
var ApiClientId = defaultClient.authentications['ApiClientId'];
ApiClientId.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientId.apiKeyPrefix = 'Token';

// Configure API key authorization: ApiClientSecret
var ApiClientSecret = defaultClient.authentications['ApiClientSecret'];
ApiClientSecret.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientSecret.apiKeyPrefix = 'Token';

var apiInstance = new KinowJavascriptSdk.ActorsApi();

var productId = 789; // Integer | Product ID to fetch

var actorId = 789; // Integer | Actor ID to detach

apiInstance.detachActorFromProduct(productId, actorId).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
productId	Integer	Product ID to fetch
actorId	Integer	Actor ID to detach

Return type

null (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getActor

ActorResponse getActor(actorId)

Get actor

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');
var defaultClient = KinowJavascriptSdk.ApiClient.instance;

// Configure API key authorization: ApiClientId
var ApiClientId = defaultClient.authentications['ApiClientId'];
ApiClientId.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientId.apiKeyPrefix = 'Token';

// Configure API key authorization: ApiClientSecret
var ApiClientSecret = defaultClient.authentications['ApiClientSecret'];
ApiClientSecret.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientSecret.apiKeyPrefix = 'Token';

var apiInstance = new KinowJavascriptSdk.ActorsApi();

var actorId = 789; // Integer | Actor ID to fetch

apiInstance.getActor(actorId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
actorId	Integer	Actor ID to fetch

Return type

ActorResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getActorCoverImage

ImageResponse getActorCoverImage(actorId)

Get cover image of an actor

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');
var defaultClient = KinowJavascriptSdk.ApiClient.instance;

// Configure API key authorization: ApiClientId
var ApiClientId = defaultClient.authentications['ApiClientId'];
ApiClientId.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientId.apiKeyPrefix = 'Token';

// Configure API key authorization: ApiClientSecret
var ApiClientSecret = defaultClient.authentications['ApiClientSecret'];
ApiClientSecret.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientSecret.apiKeyPrefix = 'Token';

var apiInstance = new KinowJavascriptSdk.ActorsApi();

var actorId = 789; // Integer | Actor ID to fetch

apiInstance.getActorCoverImage(actorId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
actorId	Integer	Actor ID to fetch

Return type

ImageResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getActorFeatures

FeatureListResponse getActorFeatures(actorId, opts)

Get actor features

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');
var defaultClient = KinowJavascriptSdk.ApiClient.instance;

// Configure API key authorization: ApiClientId
var ApiClientId = defaultClient.authentications['ApiClientId'];
ApiClientId.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientId.apiKeyPrefix = 'Token';

// Configure API key authorization: ApiClientSecret
var ApiClientSecret = defaultClient.authentications['ApiClientSecret'];
ApiClientSecret.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientSecret.apiKeyPrefix = 'Token';

var apiInstance = new KinowJavascriptSdk.ActorsApi();

var actorId = 789; // Integer | Actor ID to fetch

var opts = { 
  'page': 789, // Integer | 
  'perPage': 789 // Integer | 
};
apiInstance.getActorFeatures(actorId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
actorId	Integer	Actor ID to fetch
page	Integer		[optional]
perPage	Integer		[optional]

Return type

FeatureListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getActorProducts

ActorProductListResponse getActorProducts(actorId, opts)

Get actor products

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');
var defaultClient = KinowJavascriptSdk.ApiClient.instance;

// Configure API key authorization: ApiClientId
var ApiClientId = defaultClient.authentications['ApiClientId'];
ApiClientId.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientId.apiKeyPrefix = 'Token';

// Configure API key authorization: ApiClientSecret
var ApiClientSecret = defaultClient.authentications['ApiClientSecret'];
ApiClientSecret.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientSecret.apiKeyPrefix = 'Token';

var apiInstance = new KinowJavascriptSdk.ActorsApi();

var actorId = 789; // Integer | Actor ID to fetch

var opts = { 
  'page': 789, // Integer | 
  'perPage': 789 // Integer | 
  'sortBy': "sortBy_example", // String | Sort by this attribute (id by default)
  'sortDirection': "sortDirection_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).
};
apiInstance.getActorProducts(actorId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
actorId	Integer	Actor ID to fetch
page	Integer		[optional]
perPage	Integer		[optional]
sortBy	String	Sort by this attribute (id by default)	[optional]
sortDirection	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 _______________ { "": { "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.	[optional]
filters	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).	[optional]

Return type

ActorProductListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getActorProductsRole

ActorProductRoleListResponse getActorProductsRole(actorId, opts)

Get Products linked to Actor with their role

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');
var defaultClient = KinowJavascriptSdk.ApiClient.instance;

// Configure API key authorization: ApiClientId
var ApiClientId = defaultClient.authentications['ApiClientId'];
ApiClientId.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientId.apiKeyPrefix = 'Token';

// Configure API key authorization: ApiClientSecret
var ApiClientSecret = defaultClient.authentications['ApiClientSecret'];
ApiClientSecret.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientSecret.apiKeyPrefix = 'Token';

var apiInstance = new KinowJavascriptSdk.ActorsApi();

var actorId = 789; // Integer | Actor ID to fetch

var opts = { 
  'page': 789, // Integer | 
  'perPage': 789 // Integer | 
};
apiInstance.getActorProductsRole(actorId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
actorId	Integer	Actor ID to fetch
page	Integer		[optional]
perPage	Integer		[optional]

Return type

ActorProductRoleListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getActors

ActorListResponse getActors(opts)

Get actors list

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');
var defaultClient = KinowJavascriptSdk.ApiClient.instance;

// Configure API key authorization: ApiClientId
var ApiClientId = defaultClient.authentications['ApiClientId'];
ApiClientId.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientId.apiKeyPrefix = 'Token';

// Configure API key authorization: ApiClientSecret
var ApiClientSecret = defaultClient.authentications['ApiClientSecret'];
ApiClientSecret.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientSecret.apiKeyPrefix = 'Token';

var apiInstance = new KinowJavascriptSdk.ActorsApi();

var opts = { 
  'page': 789, // Integer | 
  'perPage': 789 // Integer | 
};
apiInstance.getActors(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
page	Integer		[optional]
perPage	Integer		[optional]

Return type

ActorListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getCategoryActors

CategoryActorsListResponse getCategoryActors(categoryId, opts)

Get actors attached to category

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');
var defaultClient = KinowJavascriptSdk.ApiClient.instance;

// Configure API key authorization: ApiClientId
var ApiClientId = defaultClient.authentications['ApiClientId'];
ApiClientId.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientId.apiKeyPrefix = 'Token';

// Configure API key authorization: ApiClientSecret
var ApiClientSecret = defaultClient.authentications['ApiClientSecret'];
ApiClientSecret.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientSecret.apiKeyPrefix = 'Token';

var apiInstance = new KinowJavascriptSdk.ActorsApi();

var categoryId = 789; // Integer | Category ID to fetch

var opts = { 
  'page': 789, // Integer | 
  'perPage': 789 // Integer | 
};
apiInstance.getCategoryActors(categoryId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
categoryId	Integer	Category ID to fetch
page	Integer		[optional]
perPage	Integer		[optional]

Return type

CategoryActorsListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getProductActors

ActorListResponse getProductActors(productId, opts)

Get actors attached to product

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');
var defaultClient = KinowJavascriptSdk.ApiClient.instance;

// Configure API key authorization: ApiClientId
var ApiClientId = defaultClient.authentications['ApiClientId'];
ApiClientId.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientId.apiKeyPrefix = 'Token';

// Configure API key authorization: ApiClientSecret
var ApiClientSecret = defaultClient.authentications['ApiClientSecret'];
ApiClientSecret.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientSecret.apiKeyPrefix = 'Token';

var apiInstance = new KinowJavascriptSdk.ActorsApi();

var productId = 789; // Integer | Product ID to fetch

var opts = { 
  'page': 789, // Integer | 
  'perPage': 789 // Integer | 
  'imageType': "imageType_example" // String | 
};
apiInstance.getProductActors(productId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
productId	Integer	Product ID to fetch
page	Integer		[optional]
perPage	Integer		[optional]
imageType	String		[optional]

Return type

ActorListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getProductActorsRole

ActorRoleListResponse getProductActorsRole(productId, opts)

Get Actors attached to Product with their role

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');
var defaultClient = KinowJavascriptSdk.ApiClient.instance;

// Configure API key authorization: ApiClientId
var ApiClientId = defaultClient.authentications['ApiClientId'];
ApiClientId.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientId.apiKeyPrefix = 'Token';

// Configure API key authorization: ApiClientSecret
var ApiClientSecret = defaultClient.authentications['ApiClientSecret'];
ApiClientSecret.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientSecret.apiKeyPrefix = 'Token';

var apiInstance = new KinowJavascriptSdk.ActorsApi();

var productId = 789; // Integer | Product ID to fetch

var opts = { 
  'page': 789, // Integer | 
  'perPage': 789 // Integer | 
};
apiInstance.getProductActorsRole(productId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
productId	Integer	Product ID to fetch
page	Integer		[optional]
perPage	Integer		[optional]

Return type

ActorRoleListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

updateActor

updateActor(actorId, body)

Update actor

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');
var defaultClient = KinowJavascriptSdk.ApiClient.instance;

// Configure API key authorization: ApiClientId
var ApiClientId = defaultClient.authentications['ApiClientId'];
ApiClientId.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientId.apiKeyPrefix = 'Token';

// Configure API key authorization: ApiClientSecret
var ApiClientSecret = defaultClient.authentications['ApiClientSecret'];
ApiClientSecret.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientSecret.apiKeyPrefix = 'Token';

var apiInstance = new KinowJavascriptSdk.ActorsApi();

var actorId = 56; // Integer | 

var body = new KinowJavascriptSdk.UpdateActorRequest(); // UpdateActorRequest | Actor settings

apiInstance.updateActor(actorId, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
actorId	Integer
body	UpdateActorRequest	Actor settings

Return type

null (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

uploadActorCover

ImageResponse uploadActorCover(actorId, opts)

Upload actor cover

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');
var defaultClient = KinowJavascriptSdk.ApiClient.instance;

// Configure API key authorization: ApiClientId
var ApiClientId = defaultClient.authentications['ApiClientId'];
ApiClientId.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientId.apiKeyPrefix = 'Token';

// Configure API key authorization: ApiClientSecret
var ApiClientSecret = defaultClient.authentications['ApiClientSecret'];
ApiClientSecret.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiClientSecret.apiKeyPrefix = 'Token';

var apiInstance = new KinowJavascriptSdk.ActorsApi();

var actorId = 3.4; // Number | Actor ID to fetch

var opts = { 
  'file': "/path/to/file.txt", // File | 
  'hash': "hash_example", // String | 
  'hashAlgorithm': "hashAlgorithm_example" // String | Hash algorithm to check the hash file (default value is: sha256)
};
apiInstance.uploadActorCover(actorId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
actorId	Number	Actor ID to fetch
file	File		[optional]
hash	String		[optional]
hashAlgorithm	String	Hash algorithm to check the hash file (default value is: sha256)	[optional]

Return type

ImageResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

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

Files

ActorsApi.md

Latest commit

History

ActorsApi.md

File metadata and controls

KinowJavascriptSdk.ActorsApi

attachActorToCategory

Example

Parameters

Return type

Authorization

HTTP request headers

attachActorToProduct

Example

Parameters

Return type

Authorization

HTTP request headers

attachFeaturesToActor

Example

Parameters

Return type

Authorization

HTTP request headers

createActor

Example

Parameters

Return type

Authorization

HTTP request headers

deleteActor

Example

Parameters

Return type

Authorization

HTTP request headers

detachActorFromCategory

Example

Parameters

Return type

Authorization

HTTP request headers

detachActorFromProduct

Example

Parameters

Return type

Authorization

HTTP request headers

getActor

Example

Parameters

Return type

Authorization

HTTP request headers

getActorCoverImage

Example

Parameters

Return type

Authorization

HTTP request headers

getActorFeatures

Example

Parameters

Return type

Authorization

HTTP request headers

getActorProducts

Example

Parameters

Return type

Authorization

HTTP request headers

getActorProductsRole

Example

Parameters

Return type

Authorization

HTTP request headers

getActors