Skip to content

Latest commit

 

History

History
executable file
·
336 lines (230 loc) · 8.99 KB

SubscriptionsApi.md

File metadata and controls

executable file
·
336 lines (230 loc) · 8.99 KB

ArtikCloud.SubscriptionsApi

All URIs are relative to https://api.artik.cloud/v1.1

Method HTTP request Description
createSubscription POST /subscriptions Create Subscription
deleteSubscription DELETE /subscriptions/{subId} Delete Subscription
getAllSubscriptions GET /subscriptions Get All Subscriptions
getMessages GET /notifications/{notifId}/messages Get Messages
getSubscription GET /subscriptions/{subId} Get Subscription
validateSubscription POST /subscriptions/{subId}/validate Validate Subscription

createSubscription

SubscriptionEnvelope createSubscription(subscriptionInfo)

Create Subscription

Create Subscription

Example

var ArtikCloud = require('artikcloud-js');
var defaultClient = ArtikCloud.ApiClient.default;

// Configure OAuth2 access token for authorization: artikcloud_oauth
var artikcloud_oauth = defaultClient.authentications['artikcloud_oauth'];
artikcloud_oauth.accessToken = "YOUR ACCESS TOKEN"

var apiInstance = new ArtikCloud.SubscriptionsApi()

var subscriptionInfo = new ArtikCloud.SubscriptionInfo(); // {SubscriptionInfo} Subscription details


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createSubscription(subscriptionInfo, callback);

Parameters

Name Type Description Notes
subscriptionInfo SubscriptionInfo Subscription details

Return type

SubscriptionEnvelope

Authorization

artikcloud_oauth

HTTP reuqest headers

  • Content-Type: Not defined
  • Accept: application/json

deleteSubscription

SubscriptionEnvelope deleteSubscription(subId)

Delete Subscription

Delete Subscription

Example

var ArtikCloud = require('artikcloud-js');
var defaultClient = ArtikCloud.ApiClient.default;

// Configure OAuth2 access token for authorization: artikcloud_oauth
var artikcloud_oauth = defaultClient.authentications['artikcloud_oauth'];
artikcloud_oauth.accessToken = "YOUR ACCESS TOKEN"

var apiInstance = new ArtikCloud.SubscriptionsApi()

var subId = "subId_example"; // {String} Subscription ID.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteSubscription(subId, callback);

Parameters

Name Type Description Notes
subId String Subscription ID.

Return type

SubscriptionEnvelope

Authorization

artikcloud_oauth

HTTP reuqest headers

  • Content-Type: Not defined
  • Accept: application/json

getAllSubscriptions

SubscriptionsEnvelope getAllSubscriptions(opts)

Get All Subscriptions

Get All Subscriptions

Example

var ArtikCloud = require('artikcloud-js');
var defaultClient = ArtikCloud.ApiClient.default;

// Configure OAuth2 access token for authorization: artikcloud_oauth
var artikcloud_oauth = defaultClient.authentications['artikcloud_oauth'];
artikcloud_oauth.accessToken = "YOUR ACCESS TOKEN"

var apiInstance = new ArtikCloud.SubscriptionsApi()

var opts = { 
  'uid': "uid_example", // {String} User ID
  'offset': 56, // {Number} Offset for pagination.
  'count': 56 // {Number} Desired count of items in the result set.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllSubscriptions(opts, callback);

Parameters

Name Type Description Notes
uid String User ID [optional]
offset Number Offset for pagination. [optional]
count Number Desired count of items in the result set. [optional]

Return type

SubscriptionsEnvelope

Authorization

artikcloud_oauth

HTTP reuqest headers

  • Content-Type: Not defined
  • Accept: application/json

getMessages

NotifMessagesResponse getMessages(notifId, opts)

Get Messages

Get Messages

Example

var ArtikCloud = require('artikcloud-js');
var defaultClient = ArtikCloud.ApiClient.default;

// Configure OAuth2 access token for authorization: artikcloud_oauth
var artikcloud_oauth = defaultClient.authentications['artikcloud_oauth'];
artikcloud_oauth.accessToken = "YOUR ACCESS TOKEN"

var apiInstance = new ArtikCloud.SubscriptionsApi()

var notifId = "notifId_example"; // {String} Notification ID.

var opts = { 
  'offset': 56, // {Number} Offset for pagination.
  'count': 56, // {Number} Desired count of items in the result set.
  'order': "order_example" // {String} Sort order of results by ts. Either 'asc' or 'desc'.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMessages(notifId, opts, callback);

Parameters

Name Type Description Notes
notifId String Notification ID.
offset Number Offset for pagination. [optional]
count Number Desired count of items in the result set. [optional]
order String Sort order of results by ts. Either 'asc' or 'desc'. [optional]

Return type

NotifMessagesResponse

Authorization

artikcloud_oauth

HTTP reuqest headers

  • Content-Type: Not defined
  • Accept: application/json

getSubscription

SubscriptionEnvelope getSubscription(subId)

Get Subscription

Get Subscription

Example

var ArtikCloud = require('artikcloud-js');
var defaultClient = ArtikCloud.ApiClient.default;

// Configure OAuth2 access token for authorization: artikcloud_oauth
var artikcloud_oauth = defaultClient.authentications['artikcloud_oauth'];
artikcloud_oauth.accessToken = "YOUR ACCESS TOKEN"

var apiInstance = new ArtikCloud.SubscriptionsApi()

var subId = "subId_example"; // {String} Subscription ID.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSubscription(subId, callback);

Parameters

Name Type Description Notes
subId String Subscription ID.

Return type

SubscriptionEnvelope

Authorization

artikcloud_oauth

HTTP reuqest headers

  • Content-Type: Not defined
  • Accept: application/json

validateSubscription

SubscriptionEnvelope validateSubscription(subId, validationCallbackRequest)

Validate Subscription

Validate Subscription

Example

var ArtikCloud = require('artikcloud-js');
var defaultClient = ArtikCloud.ApiClient.default;

// Configure OAuth2 access token for authorization: artikcloud_oauth
var artikcloud_oauth = defaultClient.authentications['artikcloud_oauth'];
artikcloud_oauth.accessToken = "YOUR ACCESS TOKEN"

var apiInstance = new ArtikCloud.SubscriptionsApi()

var subId = "subId_example"; // {String} Subscription ID.

var validationCallbackRequest = new ArtikCloud.ValidationCallbackInfo(); // {ValidationCallbackInfo} Subscription validation callback request


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.validateSubscription(subId, validationCallbackRequest, callback);

Parameters

Name Type Description Notes
subId String Subscription ID.
validationCallbackRequest ValidationCallbackInfo Subscription validation callback request

Return type

SubscriptionEnvelope

Authorization

artikcloud_oauth

HTTP reuqest headers

  • Content-Type: Not defined
  • Accept: application/json