Skip to content

Latest commit

 

History

History
571 lines (362 loc) · 16.4 KB

ProductAccessesApi.md

File metadata and controls

571 lines (362 loc) · 16.4 KB

KinowJavascriptSdk.ProductAccessesApi

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

Method HTTP request Description
createProductAccess POST /product-accesses
deleteProductAccess DELETE /product-accesses/{product_access_id}
getCustomerAccessesSubscriptions GET /customers/{customer_id}/accesses/subscriptions
getCustomerAccessesVideos GET /customers/{customer_id}/accesses/videos
getProductAccess GET /product-accesses/{product_access_id}
getProductAccesses GET /product-accesses
subscribe PUT /product-accesses/{product_access_id}/subscribe
switchSubscription PUT /product-accesses/{product_access_id}/switch
switchSubscriptionDelete DELETE /product-accesses/{product_access_id}/switch
switchSubscriptionPending GET /product-accesses/{product_access_id}/switch
unsubscribe PUT /product-accesses/{product_access_id}/unsubscribe
updateProductAccess PUT /product-accesses/{product_access_id}

createProductAccess

ProductAccess createProductAccess(body)

Create new product access

Example

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

var apiInstance = new KinowJavascriptSdk.ProductAccessesApi();

var body = new KinowJavascriptSdk.ProductAccess(); // ProductAccess | 

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

Parameters

Name Type Description Notes
body ProductAccess

Return type

ProductAccess

Authorization

No authorization required

HTTP request headers

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

deleteProductAccess

deleteProductAccess(productAccessId)

Delete product access

Example

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

var apiInstance = new KinowJavascriptSdk.ProductAccessesApi();

var productAccessId = 789; // Integer | Access ID to fetch

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

Parameters

Name Type Description Notes
productAccessId Integer Access ID to fetch

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

getCustomerAccessesSubscriptions

SubscriptionAccesses getCustomerAccessesSubscriptions(customerId, opts)

Get customer accesses for subscription

Example

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

var apiInstance = new KinowJavascriptSdk.ProductAccessesApi();

var customerId = 789; // Integer | Customer ID to fetch

var opts = { 
  'page': 789, // Integer | 
  'perPage': 789, // Integer | 
  'filters': "filters_example" // String |       ```      type[value]=string&type[operator]=strict&cancel[value]=string&cancel[operator]=contains      _______________        {      \"type\": {      \"value\": \"string\",      \"operator\": \"strict\"      },      \"cancel\": {      \"value\": \"string\",      \"operator\": \"contains\"      }      } ```Operator can be strict, contains, gt or lt.
};
apiInstance.getCustomerAccessesSubscriptions(customerId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
customerId Integer Customer ID to fetch
page Integer [optional]
perPage Integer [optional]
filters String ``` type[value]=string&type[operator]=strict&cancel[value]=string&cancel[operator]=contains _______________ { "type": { "value": "string", "operator": "strict" }, "cancel": { "value": "string", "operator": "contains" } } ```Operator can be strict, contains, gt or lt. [optional]

Return type

SubscriptionAccesses

Authorization

No authorization required

HTTP request headers

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

getCustomerAccessesVideos

SubscriptionAccesses getCustomerAccessesVideos(customerId, opts)

Get customer access for videos

Example

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

var apiInstance = new KinowJavascriptSdk.ProductAccessesApi();

var customerId = 789; // Integer | Customer ID to fetch

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

Parameters

Name Type Description Notes
customerId Integer Customer ID to fetch
page Integer [optional]
perPage Integer [optional]

Return type

SubscriptionAccesses

Authorization

No authorization required

HTTP request headers

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

getProductAccess

ProductAccess getProductAccess(productAccessId)

Get product access

Example

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

var apiInstance = new KinowJavascriptSdk.ProductAccessesApi();

var productAccessId = 789; // Integer | Product access ID to fetch

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

Parameters

Name Type Description Notes
productAccessId Integer Product access ID to fetch

Return type

ProductAccess

Authorization

No authorization required

HTTP request headers

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

getProductAccesses

SubscriptionAccesses getProductAccesses(opts)

Get product accesses list

Example

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

var apiInstance = new KinowJavascriptSdk.ProductAccessesApi();

var opts = { 
  'page': 789, // Integer | 
  'perPage': 789, // Integer | 
  'type': "type_example", // String | Filter by access type, available values are: video, sub
  'dateAdd': "dateAdd_example", // String | Filter by creation date
  'dateAddDirection': "dateAddDirection_example", // String | Choose the direction for date_add parameter, default value is after ,available values are: before, equal, after
  'dateExp': "dateExp_example", // String | Filter by expiration date
  'dateExpDirection': "dateExpDirection_example", // String | Choose the direction for date_exp parameter, default value is after ,available values are: before, equal, after
  'filters': "filters_example" // String |       ```      type[value]=string&type[operator]=strict&cancel[value]=string&cancel[operator]=contains      _______________        {      \"type\": {      \"value\": \"string\",      \"operator\": \"strict\"      },      \"cancel\": {      \"value\": \"string\",      \"operator\": \"contains\"      }      } ```Operator can be strict, contains, gt or lt.
};
apiInstance.getProductAccesses(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]
type String Filter by access type, available values are: video, sub [optional]
dateAdd String Filter by creation date [optional]
dateAddDirection String Choose the direction for date_add parameter, default value is after ,available values are: before, equal, after [optional]
dateExp String Filter by expiration date [optional]
dateExpDirection String Choose the direction for date_exp parameter, default value is after ,available values are: before, equal, after [optional]
filters String ``` type[value]=string&type[operator]=strict&cancel[value]=string&cancel[operator]=contains _______________ { "type": { "value": "string", "operator": "strict" }, "cancel": { "value": "string", "operator": "contains" } } ```Operator can be strict, contains, gt or lt. [optional]

Return type

SubscriptionAccesses

Authorization

No authorization required

HTTP request headers

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

subscribe

subscribe(productAccessId)

Subcribe to a reccuring payment for an Access

Example

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

var apiInstance = new KinowJavascriptSdk.ProductAccessesApi();

var productAccessId = 789; // Integer | Access ID to fetch

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

Parameters

Name Type Description Notes
productAccessId Integer Access ID to fetch

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

switchSubscription

switchSubscription(productAccessId, subscriptionId)

Switch an Access to another Subscription

Example

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

var apiInstance = new KinowJavascriptSdk.ProductAccessesApi();

var productAccessId = "productAccessId_example"; // String | Access ID to switch

var subscriptionId = 789; // Integer | Subscription to switch to

apiInstance.switchSubscription(productAccessId, subscriptionId).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
productAccessId String Access ID to switch
subscriptionId Integer Subscription to switch to

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

switchSubscriptionDelete

switchSubscriptionDelete(productAccessId)

Delete Access pending switch

Example

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

var apiInstance = new KinowJavascriptSdk.ProductAccessesApi();

var productAccessId = 789; // Integer | Product access ID to fetch

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

Parameters

Name Type Description Notes
productAccessId Integer Product access ID to fetch

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

switchSubscriptionPending

Subscription switchSubscriptionPending(productAccessId)

Return Access pending switch

Example

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

var apiInstance = new KinowJavascriptSdk.ProductAccessesApi();

var productAccessId = "productAccessId_example"; // String | Access ID to fetch

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

Parameters

Name Type Description Notes
productAccessId String Access ID to fetch

Return type

Subscription

Authorization

No authorization required

HTTP request headers

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

unsubscribe

unsubscribe(productAccessId)

Unsubcribe an Access recurring payment

Example

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

var apiInstance = new KinowJavascriptSdk.ProductAccessesApi();

var productAccessId = 789; // Integer | Access ID to fetch

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

Parameters

Name Type Description Notes
productAccessId Integer Access ID to fetch

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

updateProductAccess

ProductAccess updateProductAccess(productAccessId, body)

Update product access

Example

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

var apiInstance = new KinowJavascriptSdk.ProductAccessesApi();

var productAccessId = 789; // Integer | Product access ID to update

var body = new KinowJavascriptSdk.ProductAccess(); // ProductAccess | 

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

Parameters

Name Type Description Notes
productAccessId Integer Product access ID to update
body ProductAccess

Return type

ProductAccess

Authorization

No authorization required

HTTP request headers

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