npm - recombee-api-client - Versions diffs - 4.1.0 → 4.1.1 - Mend

recombee-api-client 4.1.0 → 4.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (198) hide show

package/lib/api-client.js +2 -2
package/lib/index.d.ts +3202 -0
package/lib/requests/add-bookmark.js +2 -2
package/lib/requests/add-cart-addition.js +2 -2
package/lib/requests/add-detail-view.js +2 -2
package/lib/requests/add-purchase.js +2 -2
package/lib/requests/add-rating.js +2 -2
package/lib/requests/delete-more-items.js +1 -1
package/lib/requests/recommend-item-segments-to-item-segment.js +2 -2
package/lib/requests/recommend-item-segments-to-item.js +2 -2
package/lib/requests/recommend-item-segments-to-user.js +2 -2
package/lib/requests/recommend-items-to-item.js +2 -2
package/lib/requests/recommend-items-to-user.js +2 -2
package/lib/requests/recommend-users-to-item.js +2 -2
package/lib/requests/recommend-users-to-user.js +2 -2
package/lib/requests/request.js +0 -1
package/lib/requests/search-item-segments.js +2 -2
package/lib/requests/search-items.js +2 -2
package/lib/requests/set-user-values.js +0 -1
package/lib/requests/set-view-portion.js +2 -2
package/lib/requests/update-more-items.js +2 -2
package/package.json +2 -1
package/doc/AddBookmark.html +0 -506
package/doc/AddCartAddition.html +0 -512
package/doc/AddDetailView.html +0 -509
package/doc/AddGroup.html +0 -447
package/doc/AddItem.html +0 -448
package/doc/AddItemProperty.html +0 -478
package/doc/AddPurchase.html +0 -515
package/doc/AddRating.html +0 -529
package/doc/AddSearchSynonym.html +0 -501
package/doc/AddSeries.html +0 -447
package/doc/AddUser.html +0 -447
package/doc/AddUserProperty.html +0 -476
package/doc/ApiClient.html +0 -433
package/doc/ApiError.html +0 -170
package/doc/Batch.html +0 -476
package/doc/DeleteAllSearchSynonyms.html +0 -398
package/doc/DeleteBookmark.html +0 -497
package/doc/DeleteCartAddition.html +0 -497
package/doc/DeleteDetailView.html +0 -497
package/doc/DeleteGroup.html +0 -448
package/doc/DeleteItem.html +0 -449
package/doc/DeleteItemProperty.html +0 -447
package/doc/DeleteMoreItems.html +0 -448
package/doc/DeletePurchase.html +0 -497
package/doc/DeleteRating.html +0 -497
package/doc/DeleteSearchSynonym.html +0 -447
package/doc/DeleteSeries.html +0 -448
package/doc/DeleteUser.html +0 -448
package/doc/DeleteUserProperty.html +0 -447
package/doc/DeleteViewPortion.html +0 -497
package/doc/GetItemPropertyInfo.html +0 -447
package/doc/GetItemValues.html +0 -447
package/doc/GetUserPropertyInfo.html +0 -447
package/doc/GetUserValues.html +0 -447
package/doc/InsertToGroup.html +0 -520
package/doc/InsertToSeries.html +0 -543
package/doc/ListGroupItems.html +0 -447
package/doc/ListGroups.html +0 -398
package/doc/ListItemBookmarks.html +0 -447
package/doc/ListItemCartAdditions.html +0 -447
package/doc/ListItemDetailViews.html +0 -447
package/doc/ListItemProperties.html +0 -398
package/doc/ListItemPurchases.html +0 -447
package/doc/ListItemRatings.html +0 -447
package/doc/ListItemViewPortions.html +0 -447
package/doc/ListItems.html +0 -497
package/doc/ListSearchSynonyms.html +0 -454
package/doc/ListSeries.html +0 -398
package/doc/ListSeriesItems.html +0 -447
package/doc/ListUserBookmarks.html +0 -447
package/doc/ListUserCartAdditions.html +0 -447
package/doc/ListUserDetailViews.html +0 -447
package/doc/ListUserProperties.html +0 -398
package/doc/ListUserPurchases.html +0 -447
package/doc/ListUserRatings.html +0 -447
package/doc/ListUserViewPortions.html +0 -447
package/doc/ListUsers.html +0 -491
package/doc/MergeUsers.html +0 -498
package/doc/RecommendItemsToItem.html +0 -635
package/doc/RecommendItemsToUser.html +0 -598
package/doc/RecommendNextItems.html +0 -480
package/doc/RecommendUsersToItem.html +0 -579
package/doc/RecommendUsersToUser.html +0 -588
package/doc/RemoveFromGroup.html +0 -493
package/doc/RemoveFromSeries.html +0 -516
package/doc/Request.html +0 -292
package/doc/ResetDatabase.html +0 -398
package/doc/ResponseError.html +0 -269
package/doc/SearchItems.html +0 -610
package/doc/SetItemValues.html +0 -279
package/doc/SetUserValues.html +0 -277
package/doc/SetValues.html +0 -480
package/doc/SetViewPortion.html +0 -533
package/doc/TimeoutError.html +0 -246
package/doc/UpdateMoreItems.html +0 -472
package/doc/api-client.js.html +0 -248
package/doc/errors_api-error.js.html +0 -71
package/doc/errors_response-error.js.html +0 -72
package/doc/errors_timeout-error.js.html +0 -71
package/doc/fonts/OpenSans-Bold-webfont.eot +0 -0
package/doc/fonts/OpenSans-Bold-webfont.svg +0 -1830
package/doc/fonts/OpenSans-Bold-webfont.woff +0 -0
package/doc/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
package/doc/fonts/OpenSans-BoldItalic-webfont.svg +0 -1830
package/doc/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
package/doc/fonts/OpenSans-Italic-webfont.eot +0 -0
package/doc/fonts/OpenSans-Italic-webfont.svg +0 -1830
package/doc/fonts/OpenSans-Italic-webfont.woff +0 -0
package/doc/fonts/OpenSans-Light-webfont.eot +0 -0
package/doc/fonts/OpenSans-Light-webfont.svg +0 -1831
package/doc/fonts/OpenSans-Light-webfont.woff +0 -0
package/doc/fonts/OpenSans-LightItalic-webfont.eot +0 -0
package/doc/fonts/OpenSans-LightItalic-webfont.svg +0 -1835
package/doc/fonts/OpenSans-LightItalic-webfont.woff +0 -0
package/doc/fonts/OpenSans-Regular-webfont.eot +0 -0
package/doc/fonts/OpenSans-Regular-webfont.svg +0 -1831
package/doc/fonts/OpenSans-Regular-webfont.woff +0 -0
package/doc/index.html +0 -65
package/doc/requests_add-bookmark.js.html +0 -128
package/doc/requests_add-cart-addition.js.html +0 -142
package/doc/requests_add-detail-view.js.html +0 -135
package/doc/requests_add-group.js.html +0 -93
package/doc/requests_add-item-property.js.html +0 -104
package/doc/requests_add-item.js.html +0 -94
package/doc/requests_add-purchase.js.html +0 -149
package/doc/requests_add-rating.js.html +0 -131
package/doc/requests_add-search-synonym.js.html +0 -111
package/doc/requests_add-series.js.html +0 -93
package/doc/requests_add-user-property.js.html +0 -102
package/doc/requests_add-user.js.html +0 -93
package/doc/requests_batch.js.html +0 -121
package/doc/requests_delete-all-search-synonyms.js.html +0 -91
package/doc/requests_delete-bookmark.js.html +0 -106
package/doc/requests_delete-cart-addition.js.html +0 -106
package/doc/requests_delete-detail-view.js.html +0 -106
package/doc/requests_delete-group.js.html +0 -94
package/doc/requests_delete-item-property.js.html +0 -93
package/doc/requests_delete-item.js.html +0 -95
package/doc/requests_delete-more-items.js.html +0 -95
package/doc/requests_delete-purchase.js.html +0 -106
package/doc/requests_delete-rating.js.html +0 -106
package/doc/requests_delete-search-synonym.js.html +0 -93
package/doc/requests_delete-series.js.html +0 -94
package/doc/requests_delete-user-property.js.html +0 -93
package/doc/requests_delete-user.js.html +0 -94
package/doc/requests_delete-view-portion.js.html +0 -106
package/doc/requests_get-item-property-info.js.html +0 -93
package/doc/requests_get-item-values.js.html +0 -93
package/doc/requests_get-user-property-info.js.html +0 -93
package/doc/requests_get-user-values.js.html +0 -93
package/doc/requests_insert-to-group.js.html +0 -109
package/doc/requests_insert-to-series.js.html +0 -112
package/doc/requests_list-group-items.js.html +0 -93
package/doc/requests_list-groups.js.html +0 -91
package/doc/requests_list-item-bookmarks.js.html +0 -93
package/doc/requests_list-item-cart-additions.js.html +0 -93
package/doc/requests_list-item-detail-views.js.html +0 -93
package/doc/requests_list-item-properties.js.html +0 -91
package/doc/requests_list-item-purchases.js.html +0 -93
package/doc/requests_list-item-ratings.js.html +0 -93
package/doc/requests_list-item-view-portions.js.html +0 -93
package/doc/requests_list-items.js.html +0 -158
package/doc/requests_list-search-synonyms.js.html +0 -106
package/doc/requests_list-series-items.js.html +0 -93
package/doc/requests_list-series.js.html +0 -91
package/doc/requests_list-user-bookmarks.js.html +0 -93
package/doc/requests_list-user-cart-additions.js.html +0 -93
package/doc/requests_list-user-detail-views.js.html +0 -93
package/doc/requests_list-user-properties.js.html +0 -91
package/doc/requests_list-user-purchases.js.html +0 -93
package/doc/requests_list-user-ratings.js.html +0 -93
package/doc/requests_list-user-view-portions.js.html +0 -93
package/doc/requests_list-users.js.html +0 -152
package/doc/requests_merge-users.js.html +0 -105
package/doc/requests_recommend-items-to-item.js.html +0 -276
package/doc/requests_recommend-items-to-user.js.html +0 -255
package/doc/requests_recommend-next-items.js.html +0 -106
package/doc/requests_recommend-users-to-item.js.html +0 -224
package/doc/requests_recommend-users-to-user.js.html +0 -245
package/doc/requests_remove-from-group.js.html +0 -99
package/doc/requests_remove-from-series.js.html +0 -102
package/doc/requests_request.js.html +0 -73
package/doc/requests_reset-database.js.html +0 -91
package/doc/requests_search-items.js.html +0 -231
package/doc/requests_set-item-values.js.html +0 -80
package/doc/requests_set-user-values.js.html +0 -79
package/doc/requests_set-values.js.html +0 -102
package/doc/requests_set-view-portion.js.html +0 -139
package/doc/requests_update-more-items.js.html +0 -104
package/doc/scripts/linenumber.js +0 -25
package/doc/scripts/prettify/Apache-License-2.0.txt +0 -202
package/doc/scripts/prettify/lang-css.js +0 -2
package/doc/scripts/prettify/prettify.js +0 -28
package/doc/styles/jsdoc-default.css +0 -358
package/doc/styles/prettify-jsdoc.css +0 -111
package/doc/styles/prettify-tomorrow.css +0 -132

package/doc/SetViewPortion.html DELETED Viewed

@@ -1,533 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>JSDoc: Class: SetViewPortion</title>
-    <script src="scripts/prettify/prettify.js"> </script>
-    <script src="scripts/prettify/lang-css.js"> </script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-<body>
-<div id="main">
-    <h1 class="page-title">Class: SetViewPortion</h1>
-<section>
-<header>
-        <h2><span class="attribs"><span class="type-signature"></span></span>SetViewPortion<span class="signature">(userId, itemId, portion, optional)</span><span class="type-signature"></span></h2>
-            <div class="class-description">Sets viewed portion of an item (for example a video or article) by a user (at a session).
-If you send new request with the same (`userId`, `itemId`, `sessionId`), the portion gets updated.</div>
-</header>
-<article>
-    <div class="container-overview">
-    <h2>Constructor</h2>
-    <h4 class="name" id="SetViewPortion"><span class="type-signature"></span>new SetViewPortion<span class="signature">(userId, itemId, portion, optional)</span><span class="type-signature"></span></h4>
-<div class="description">
-    Construct the request
-</div>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>userId</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-            <td class="description last">User who viewed a portion of the item</td>
-        </tr>
-        <tr>
-                <td class="name"><code>itemId</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-            <td class="description last">Viewed item</td>
-        </tr>
-        <tr>
-                <td class="name"><code>portion</code></td>
-            <td class="type">
-<span class="param-type">number</span>
-            </td>
-            <td class="description last">Viewed portion of the item (number between 0.0 (viewed nothing) and 1.0 (viewed full item) ). It should be the really viewed part of the item, no matter seeking, so for example if the user seeked immediately to half of the item and then viewed 10% of the item, the `portion` should still be `0.1`.</td>
-        </tr>
-        <tr>
-                <td class="name"><code>optional</code></td>
-            <td class="type">
-<span class="param-type">Object</span>
-            </td>
-            <td class="description last">Optional parameters given as an object with structure name of the parameter: value
-- Allowed parameters:
-    - *sessionId*
-        - Type: string
-        - Description: ID of session in which the user viewed the item. Default is `null` (`None`, `nil`, `NULL` etc. depending on language).
-    - *timestamp*
-        - Type: string|number
-        - Description: UTC timestamp of the rating as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
-    - *cascadeCreate*
-        - Type: boolean
-        - Description: Sets whether the given user/item should be created if not present in the database.
-    - *recommId*
-        - Type: string
-        - Description: If this view portion is based on a recommendation request, `recommId` is the id of the clicked recommendation.
-    - *additionalData*
-        - Type:
-        - Description: A dictionary of additional data for the interaction.</td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="requests_set-view-portion.js.html">requests/set-view-portion.js</a>, <a href="requests_set-view-portion.js.html#line12">line 12</a>
-    </li></ul></dd>
-</dl>
-    </div>
-        <h3 class="subsection-title">Methods</h3>
-    <h4 class="name" id="bodyParameters"><span class="type-signature"></span>bodyParameters<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
-<div class="description">
-    Get body parameters
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="requests_set-view-portion.js.html">requests/set-view-portion.js</a>, <a href="requests_set-view-portion.js.html#line54">line 54</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    The values of body parameters (name of parameter: value of the parameter)
-</div>
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Object</span>
-    </dd>
-</dl>
-    <h4 class="name" id="queryParameters"><span class="type-signature"></span>queryParameters<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
-<div class="description">
-    Get query parameters
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="requests_set-view-portion.js.html">requests/set-view-portion.js</a>, <a href="requests_set-view-portion.js.html#line82">line 82</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    The values of query parameters (name of parameter: value of the parameter)
-</div>
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Object</span>
-    </dd>
-</dl>
-</article>
-</section>
-</div>
-<nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AddBookmark.html">AddBookmark</a></li><li><a href="AddCartAddition.html">AddCartAddition</a></li><li><a href="AddDetailView.html">AddDetailView</a></li><li><a href="AddGroup.html">AddGroup</a></li><li><a href="AddItem.html">AddItem</a></li><li><a href="AddItemProperty.html">AddItemProperty</a></li><li><a href="AddPurchase.html">AddPurchase</a></li><li><a href="AddRating.html">AddRating</a></li><li><a href="AddSearchSynonym.html">AddSearchSynonym</a></li><li><a href="AddSeries.html">AddSeries</a></li><li><a href="AddUser.html">AddUser</a></li><li><a href="AddUserProperty.html">AddUserProperty</a></li><li><a href="ApiClient.html">ApiClient</a></li><li><a href="ApiError.html">ApiError</a></li><li><a href="Batch.html">Batch</a></li><li><a href="DeleteAllSearchSynonyms.html">DeleteAllSearchSynonyms</a></li><li><a href="DeleteBookmark.html">DeleteBookmark</a></li><li><a href="DeleteCartAddition.html">DeleteCartAddition</a></li><li><a href="DeleteDetailView.html">DeleteDetailView</a></li><li><a href="DeleteGroup.html">DeleteGroup</a></li><li><a href="DeleteItem.html">DeleteItem</a></li><li><a href="DeleteItemProperty.html">DeleteItemProperty</a></li><li><a href="DeleteMoreItems.html">DeleteMoreItems</a></li><li><a href="DeletePurchase.html">DeletePurchase</a></li><li><a href="DeleteRating.html">DeleteRating</a></li><li><a href="DeleteSearchSynonym.html">DeleteSearchSynonym</a></li><li><a href="DeleteSeries.html">DeleteSeries</a></li><li><a href="DeleteUser.html">DeleteUser</a></li><li><a href="DeleteUserProperty.html">DeleteUserProperty</a></li><li><a href="DeleteViewPortion.html">DeleteViewPortion</a></li><li><a href="GetItemPropertyInfo.html">GetItemPropertyInfo</a></li><li><a href="GetItemValues.html">GetItemValues</a></li><li><a href="GetUserPropertyInfo.html">GetUserPropertyInfo</a></li><li><a href="GetUserValues.html">GetUserValues</a></li><li><a href="InsertToGroup.html">InsertToGroup</a></li><li><a href="InsertToSeries.html">InsertToSeries</a></li><li><a href="ListGroupItems.html">ListGroupItems</a></li><li><a href="ListGroups.html">ListGroups</a></li><li><a href="ListItemBookmarks.html">ListItemBookmarks</a></li><li><a href="ListItemCartAdditions.html">ListItemCartAdditions</a></li><li><a href="ListItemDetailViews.html">ListItemDetailViews</a></li><li><a href="ListItemProperties.html">ListItemProperties</a></li><li><a href="ListItemPurchases.html">ListItemPurchases</a></li><li><a href="ListItemRatings.html">ListItemRatings</a></li><li><a href="ListItems.html">ListItems</a></li><li><a href="ListItemViewPortions.html">ListItemViewPortions</a></li><li><a href="ListSearchSynonyms.html">ListSearchSynonyms</a></li><li><a href="ListSeries.html">ListSeries</a></li><li><a href="ListSeriesItems.html">ListSeriesItems</a></li><li><a href="ListUserBookmarks.html">ListUserBookmarks</a></li><li><a href="ListUserCartAdditions.html">ListUserCartAdditions</a></li><li><a href="ListUserDetailViews.html">ListUserDetailViews</a></li><li><a href="ListUserProperties.html">ListUserProperties</a></li><li><a href="ListUserPurchases.html">ListUserPurchases</a></li><li><a href="ListUserRatings.html">ListUserRatings</a></li><li><a href="ListUsers.html">ListUsers</a></li><li><a href="ListUserViewPortions.html">ListUserViewPortions</a></li><li><a href="MergeUsers.html">MergeUsers</a></li><li><a href="RecommendItemsToItem.html">RecommendItemsToItem</a></li><li><a href="RecommendItemsToUser.html">RecommendItemsToUser</a></li><li><a href="RecommendNextItems.html">RecommendNextItems</a></li><li><a href="RecommendUsersToItem.html">RecommendUsersToItem</a></li><li><a href="RecommendUsersToUser.html">RecommendUsersToUser</a></li><li><a href="RemoveFromGroup.html">RemoveFromGroup</a></li><li><a href="RemoveFromSeries.html">RemoveFromSeries</a></li><li><a href="Request.html">Request</a></li><li><a href="ResetDatabase.html">ResetDatabase</a></li><li><a href="ResponseError.html">ResponseError</a></li><li><a href="SearchItems.html">SearchItems</a></li><li><a href="SetItemValues.html">SetItemValues</a></li><li><a href="SetUserValues.html">SetUserValues</a></li><li><a href="SetValues.html">SetValues</a></li><li><a href="SetViewPortion.html">SetViewPortion</a></li><li><a href="TimeoutError.html">TimeoutError</a></li><li><a href="UpdateMoreItems.html">UpdateMoreItems</a></li></ul>
-</nav>
-<br class="clear">
-<footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Mon Apr 25 2022 16:02:57 GMT+0200 (Central European Summer Time)
-</footer>
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>