Skip to content

Latest commit

 

History

History
345 lines (221 loc) · 8.54 KB

SubscriptionsApi.md

File metadata and controls

345 lines (221 loc) · 8.54 KB

KinowJavascriptSdk.SubscriptionsApi

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

Method HTTP request Description
getDisabledSubscriptions GET /videos/{video_id}/disabled-subscriptions
getProductSubscription GET /products/{product_id}/subscription
getSubscription GET /subscriptions/{subscription_id}
getSubscriptionCategories GET /subscriptions/{subscription_id}/categories
getSubscriptionCoverImage GET /subscriptions/{subscription_id}/cover
getSubscriptions GET /subscriptions
uploadSubscriptionCover POST /subscriptions/{subscription_id}/cover

getDisabledSubscriptions

Subscriptions getDisabledSubscriptions(videoId, opts)

Get disabled subscriptions list

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');

var apiInstance = new KinowJavascriptSdk.SubscriptionsApi();

var videoId = 789; // Integer | Video ID to fetch

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

Parameters

Name Type Description Notes
videoId Integer Video ID to fetch
page Integer [optional]
perPage Integer [optional]

Return type

Subscriptions

Authorization

No authorization required

HTTP request headers

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

getProductSubscription

Subscription getProductSubscription(productId)

Get Subscription linked to a Product

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');

var apiInstance = new KinowJavascriptSdk.SubscriptionsApi();

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

apiInstance.getProductSubscription(productId).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

Return type

Subscription

Authorization

No authorization required

HTTP request headers

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

getSubscription

Subscription getSubscription(subscriptionId)

Get Subscription

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');

var apiInstance = new KinowJavascriptSdk.SubscriptionsApi();

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

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

Parameters

Name Type Description Notes
subscriptionId Integer Product ID to fetch

Return type

Subscription

Authorization

No authorization required

HTTP request headers

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

getSubscriptionCategories

Categories getSubscriptionCategories(subscriptionId, opts)

Get categories list

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');

var apiInstance = new KinowJavascriptSdk.SubscriptionsApi();

var subscriptionId = 789; // Integer | 

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)
};
apiInstance.getSubscriptionCategories(subscriptionId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
subscriptionId Integer
page Integer [optional]
perPage Integer [optional]
sortBy String Sort by this attribute (id by default) [optional]
sortDirection String Sorting direction (asc by default) [optional]

Return type

Categories

Authorization

No authorization required

HTTP request headers

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

getSubscriptionCoverImage

Image getSubscriptionCoverImage(subscriptionId)

Get cover image of a subscription

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');

var apiInstance = new KinowJavascriptSdk.SubscriptionsApi();

var subscriptionId = 789; // Integer | Subscription ID to fetch

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

Parameters

Name Type Description Notes
subscriptionId Integer Subscription ID to fetch

Return type

Image

Authorization

No authorization required

HTTP request headers

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

getSubscriptions

Subscriptions getSubscriptions(opts)

Get Subscriptions list

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');

var apiInstance = new KinowJavascriptSdk.SubscriptionsApi();

var opts = { 
  'page': 789, // Integer | 
  'perPage': 789 // Integer | 
};
apiInstance.getSubscriptions(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

Subscriptions

Authorization

No authorization required

HTTP request headers

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

uploadSubscriptionCover

Image uploadSubscriptionCover(subscriptionId, file, hash, opts)

Upload subscription cover

Example

var KinowJavascriptSdk = require('kinow-javascript-sdk');

var apiInstance = new KinowJavascriptSdk.SubscriptionsApi();

var subscriptionId = 3.4; // Number | Subscription ID to fetch

var file = "/path/to/file.txt"; // File | 

var hash = "hash_example"; // String | 

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

Parameters

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

Return type

Image

Authorization

No authorization required

HTTP request headers

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