Pipeless PHP bindings

Power real-time personalized recommendations and activity feeds using a simple API. https://docs.pipeless.io

Requirements

PHP 7.1 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

composer require pipeless/pipeless-php

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/pipeless-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: App_API_Key
$config = Pipeless\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'Bearer YOUR_API_KEY');

$apiInstance = new Pipeless\Api\ActivityApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = 123;

$params = [

];

try {
    $result = $apiInstance->getActivityActionsFeed($app_id, $params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActivityApi->getActivityActionsFeed: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

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

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

Documentation For Models

• Errors
• GetActivityActionsFeedResult
• GetActivityActionsFeedResultActions
• GetActivityActionsFeedResultEvents
• GetActivityFeedResult
• GetActivityFeedResultEvents
• GetActivityOnObjectResult
• GetActivityOnObjectResultEvents
• GetRecentEventsConfig
• GetRecentEventsResultItem
• GetRecentEventsResultItemEvent
• ObjectReadable
• ObjectType
• PageInfo
• RecommendationsContentResult
• RecommendationsContentResultItems
• RecommendationsResult
• RecommendationsResultItems
• RelationshipCountsResult
• RelationshipCountsResultStats
• RelationshipDirection
• RelationshipExistsResult
• RelationshipReadable
• RelationshipType
• RelationshipWriteable

Documentation For Authorization

App_API_Key

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

Author