pipeless

Pipeless - JavaScript client for the Pipeless API (https://docs.pipeless.io)

Installation

For Node.js

npm

Install it via:

npm install pipeless --save

Getting Started

Please follow the installation instruction and execute the following JS code:

var Pipeless = require('pipeless');

var defaultClient = Pipeless.ApiClient.instance;
// Configure API key authorization: App_API_Key
var App_API_Key = defaultClient.authentications['App_API_Key'];
App_API_Key.apiKey = "Bearer YOUR_API_KEY"

var api = new Pipeless.ActivityApi()
var appId = 123; // {Number} 
var opts = {};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getActivityActionsFeed(appId, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.pipeless.io

Class	Method	HTTP request	Description
Pipeless.ActivityApi	getActivityActionsFeed	GET /v1/apps/{app_id}/algos/activity/actions-feed	Get Activity Actions Feed
Pipeless.ActivityApi	getActivityFeed	GET /v1/apps/{app_id}/algos/activity/feed	Get Activity Feed
Pipeless.ActivityApi	getActivityOnObject	GET /v1/apps/{app_id}/algos/activity/object	Get Activity on Object
Pipeless.GeneralApi	createEvent	POST /v1/apps/{app_id}/events	Create Event
Pipeless.GeneralApi	createEventsBatch	POST /v1/apps/{app_id}/events/batch	Create Events Batch
Pipeless.GeneralApi	deleteAllObjectsByType	DELETE /v1/apps/{app_id}/objects/all	Delete All Objects by Type
Pipeless.GeneralApi	deleteEvent	DELETE /v1/apps/{app_id}/events	Delete Event
Pipeless.GeneralApi	deleteObject	DELETE /v1/apps/{app_id}/objects	Delete Object
Pipeless.GeneralApi	editObject	PATCH /v1/apps/{app_id}/objects	Edit Object
Pipeless.GeneralApi	getObject	GET /v1/apps/{app_id}/objects	Get Object
Pipeless.GeneralApi	getRecentEvents	GET /v1/apps/{app_id}/recent-events	Get Recent Events
Pipeless.RecommendationsApi	getRecommendedContent	GET /v1/apps/{app_id}/algos/recommendations/content	Get Recommended Content (for user)
Pipeless.RecommendationsApi	getRecommendedUsersToFollow	GET /v1/apps/{app_id}/algos/recommendations/users-to-follow	Get Recommended Users to Follow (for user)
Pipeless.RecommendationsApi	getRelatedContent	GET /v1/apps/{app_id}/algos/recommendations/related-content	Get Related Content
Pipeless.RecommendationsApi	getRelatedTags	GET /v1/apps/{app_id}/algos/recommendations/related-tags	Get Related Tags
Pipeless.RecommendationsApi	getRelatedUsers	GET /v1/apps/{app_id}/algos/recommendations/related-users	Get Related Users

Documentation for Models

• Pipeless.Errors
• Pipeless.GetActivityActionsFeedResult
• Pipeless.GetActivityActionsFeedResultActions
• Pipeless.GetActivityActionsFeedResultEvents
• Pipeless.GetActivityFeedResult
• Pipeless.GetActivityFeedResultEvents
• Pipeless.GetActivityOnObjectResult
• Pipeless.GetActivityOnObjectResultEvents
• Pipeless.GetRecentEventsConfig
• Pipeless.GetRecentEventsResultItem
• Pipeless.GetRecentEventsResultItemEvent
• Pipeless.ObjectLookup
• Pipeless.ObjectReadable
• Pipeless.ObjectType
• Pipeless.ObjectWildcardLookup
• Pipeless.ObjectWriteable
• Pipeless.PageInfo
• Pipeless.RecommendationsResult
• Pipeless.RecommendationsResultItems
• Pipeless.RelationshipDirection
• Pipeless.RelationshipReadable
• Pipeless.RelationshipType
• Pipeless.RelationshipWriteable

Documentation for Authorization

App_API_Key

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header