Skip to content

Latest commit

 

History

History
112 lines (86 loc) · 3.42 KB

UPGRADE-3.0.md

File metadata and controls

112 lines (86 loc) · 3.42 KB
Raw

Upgrading from 2.x to 3.0

API client release 3.0 contains few backward incompatible changes.

This guide will help you upgrade your codebase.

UserRecommendation::create() now accepts only $userId and $scenario

UserRecommendation::create() accepts only two arguments: $user_id and $scenario.

Both arguments are required.

All other arguments can be now set using new setters and are optional:

  • setCount(int $count)
  • setRotationRate(float $rotationRate)
  • setRotationTime(int $rotationTime)

Before

$recommendation = UserRecommendation::create('user-id', 5, 'scenario', 1.0, 3600);

After

$recommendation = UserRecommendation::create('user-id', 'scenario')
    ->setCount(5)
    ->setRotationRate(1.0)
    ->setRotationTime(3600);

which is equivalent to

$recommendation = UserRecommendation::create('user-id', 'scenario');
$recommendation->setCount(5);
$recommendation->setRotationRate(1.0);
$recommendation->setRotationTime(3600);

Interaction now accepts interaction type as parameter

Matej now allows configuration of custom interaction types and interaction attributes.

At the same time, it allows specifying interaction item using item alias instead of item ID. For that reason we removed static constructor methods for creating specific interaction types - Interaction::detailView, Interaction::purchase, Interaction::bookmark and Interaction::rating.

We replaced them with constructors for creating Interaction based on $itemId or $itemIdAlias:

Interaction::withItem(
    string $interactionType,
    string $userId,
    string $itemId,
    int $timestamp = null
);
Interaction::withAliasedItem(
    string $interactionType,
    string $userId,
    array $itemIdAlias,
    int $timestamp = null
);

The first argument is always a string representing interaction type. Consult the table bellow to find out the correct value to fill in:

Before: constructor method After: argument $interactionType
Interaction::detailView "detailviews"
Interaction::purchase "purchases"
Interaction::bookmark "bookmarks"
Interaction::rating "ratings"

To request new interaction types, please contact Matej support.

Before

$interaction = Interaction::bookmark('user-id', 'item_id', time());

After

$interaction = Interaction::withItem('bookmarks', 'user-id', 'item_id', time());

Argument $timestamp remains optional.

Interaction command supports custom attributes

Interactions now support custom attributes. These can be added using fluent API methods setAttribute() and setAttributes().

Argument value was removed from constructor methods and has to be set using new attribute methods. Its real name might have changed as well. For example, for interaction type ratings, it was renamed to stars.

Attribute context is no longer supported and was removed.

Before

$interaction = Interaction::rating('user-id', 'item-id', 0.5);

After

$interaction = Interaction::withItem('ratings', 'user-id', 'item-id')
    ->setAttribute('stars', 0.5);

which is equivalent to

$interaction = Interaction::withItem('ratings', 'user-id', 'item-id');
$interaction->setAttribute('stars', 0.5);