Merge pull request #776 from inplayer-org/watch-history-endpoints-update

Fix:  Watch history endpoints wrong names and type names

Author: kiremitrov123

.DS_Store

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+# [3.13.4] - 15-12-2022
+
+### Added
+
+- Replaced watchlist history endpoint name with watch history
+
 # [3.13.3] - 06-12-2022
 
 ### Added

CHANGELOG.md

@@ -173,7 +173,7 @@ export declare interface ExternalAccount {
   token: string;
 }
 
-export interface WatchlistHistory {
+export interface WatchHistory {
   media_id: string;
   progress: number;
   created_at: number;
@@ -251,14 +251,12 @@ export declare class Account {
   deleteFromFavorites(mediaId: string): Promise<AxiosResponse<CommonResponse>>;
   getWatchHistory(
     args: CollectionWithCursorArgs
-  ): Promise<AxiosResponse<CollectionWithCursor<WatchlistHistory>>>;
-  getWatchHistoryForItem(
-    mediaId: string
-  ): Promise<AxiosResponse<WatchlistHistory>>;
+  ): Promise<AxiosResponse<CollectionWithCursor<WatchHistory>>>;
+  getWatchHistoryForItem(mediaId: string): Promise<AxiosResponse<WatchHistory>>;
   updateWatchHistory(
     mediaId: string,
     progress: number
-  ): Promise<AxiosResponse<WatchlistHistory>>;
+  ): Promise<AxiosResponse<WatchHistory>>;
   deleteWatchHistoryForItem(
     mediaId: string
   ): Promise<AxiosResponse<CommonResponse>>;

index.d.ts

@@ -1,6 +1,6 @@
 {
   "name": "@inplayer-org/inplayer.js",
-  "version": "3.13.3",
+  "version": "3.13.4",
   "author": "InPlayer",
   "license": "MIT",
   "description": "A Javascript SDK for Inplayer's RESTful API",

package.json

@@ -25,9 +25,9 @@ export const API = {
     `/v2/accounts/external/${integration}`,
   getFavorites: '/v2/accounts/media/favorites',
   getFavorite: (id: string): string => `/v2/accounts/media/favorites/${id}`,
-  getWatchHistory: '/v2/accounts/media/watchlist-history',
-  getWatchHistoryForItem: (id: string) =>
-    `/v2/accounts/media/watchlist-history/${id}`,
+  getWatchHistory: '/v2/accounts/media/watch-history',
+  getWatchHistoryForItem: (id: string): string =>
+    `/v2/accounts/media/watch-history/${id}`,
   // restrictions
   merchantRestrictionSettings: (merchantUuid: string): string =>
     `/restrictions/settings/${merchantUuid}`,

src/constants/index.ts

@@ -12,7 +12,7 @@ import {
   AccountProfile,
   CollectionWithCursor,
   FavoritesData,
-  WatchlistHistory,
+  WatchHistory,
   CollectionWithCursorArgs,
 } from '../models/IAccount&Authentication';
 import {
@@ -1240,7 +1240,7 @@ class Account extends BaseExtend {
   }
 
   /**
-   * Returns the viewer's watchlist history
+   * Returns the viewer's watch history
    * @method getWatchHistory
    * @param {string} filter the filter can be one of all, watched or currently_watching.
    * The default is: currently_watching
@@ -1250,7 +1250,7 @@ class Account extends BaseExtend {
    *     InPlayer.Account
    *     .getWatchHistory({filter:"all"})
    *     .then(data => console.log(data));
-   * @returns  {CollectionWithCursor<WatchlistHistory>} Contains the data:
+   * @returns  {CollectionWithCursor<WatchHistory>} Contains the data:
    * ```typescript
    * {
    *  "collection": [{
@@ -1259,15 +1259,15 @@ class Account extends BaseExtend {
    *    "created_at": 1532425425,
    *    "updated_at": 1532425425
    *  }],
-   *  "cursor": "https://services.inplayer.com/v2/accounts/media/watchlist-history?cursor=Ksm34S"
+   *  "cursor": "https://services.inplayer.com/v2/accounts/media/watch-history?cursor=Ksm34S"
    * }
    * ```
    */
   async getWatchHistory({
     filter = 'currently_watching',
     cursor = '',
   }: CollectionWithCursorArgs): Promise<
-    AxiosResponse<CollectionWithCursor<WatchlistHistory>>
+    AxiosResponse<CollectionWithCursor<WatchHistory>>
   > {
     const tokenObject = await this.request.getToken();
     return this.request.get(
@@ -1282,15 +1282,15 @@ class Account extends BaseExtend {
   }
 
   /**
-   * Returns the viewer's watchlist history media item
+   * Returns the viewer's watch history media item
    * @method getWatchHistoryForItem
    * @param {string} mediaId The external ID
    * @async
    * @example
    *     InPlayer.Account
    *     .getWatchHistoryForItem("awWEFyPu")
    *     .then(data => console.log(data));
-   * @returns  {AxiosResponse<WatchlistHistory>} Contains the data:
+   * @returns  {AxiosResponse<WatchHistory>} Contains the data:
    * ```typescript
    *  {
    *    "media_id": "awWEFyPu",
@@ -1302,7 +1302,7 @@ class Account extends BaseExtend {
    */
   async getWatchHistoryForItem(
     mediaId: string,
-  ): Promise<AxiosResponse<WatchlistHistory>> {
+  ): Promise<AxiosResponse<WatchHistory>> {
     const tokenObject = await this.request.getToken();
     return this.request.get(API.getWatchHistoryForItem(mediaId), {
       headers: {
@@ -1313,7 +1313,7 @@ class Account extends BaseExtend {
   }
 
   /**
-   * Updates the viewer's watchlist history media item
+   * Updates the viewer's watch history media item
    * @method updateWatchHistory
    * @param {string} mediaId The external ID
    * @param {number} progress The progress of the watched video in percent
@@ -1322,7 +1322,7 @@ class Account extends BaseExtend {
    *     InPlayer.Account
    *     .updateWatchHistory("awWEFyPu", 0.3434)
    *     .then(data => console.log(data));
-   * @returns  {AxiosResponse<WatchlistHistory>} Contains the data:
+   * @returns  {AxiosResponse<WatchHistory>} Contains the data:
    * ```typescript
    *  {
    *    "media_id": "awWEFyPu",
@@ -1335,7 +1335,7 @@ class Account extends BaseExtend {
   async updateWatchHistory(
     mediaId: string,
     progress: number,
-  ): Promise<AxiosResponse<WatchlistHistory>> {
+  ): Promise<AxiosResponse<WatchHistory>> {
     const body = {
       media_id: mediaId,
       progress,
@@ -1350,7 +1350,7 @@ class Account extends BaseExtend {
   }
 
   /**
-   * Deletes viewer's watchlist history media item
+   * Deletes viewer's watch history media item
    * @method deleteWatchHistoryForItem
    * @param {string} mediaId The external ID
    * @async

src/endpoints/account.ts

@@ -158,7 +158,7 @@ export interface RestrictionSettingsData {
   created_at: number;
   updated_at: number;
 }
-export interface WatchlistHistory {
+export interface WatchHistory {
   media_id: string;
   progress: number;
   created_at: number;
@@ -224,14 +224,12 @@ export interface Account extends BaseExtend {
   deleteFromFavorites(mediaId: string): Promise<AxiosResponse<CommonResponse>>;
   getWatchHistory(
     args: CollectionWithCursorArgs
-  ): Promise<AxiosResponse<CollectionWithCursor<WatchlistHistory>>>;
-  getWatchHistoryForItem(
-    mediaId: string
-  ): Promise<AxiosResponse<WatchlistHistory>>;
+  ): Promise<AxiosResponse<CollectionWithCursor<WatchHistory>>>;
+  getWatchHistoryForItem(mediaId: string): Promise<AxiosResponse<WatchHistory>>;
   updateWatchHistory(
     mediaId: string,
     progress: number
-  ): Promise<AxiosResponse<WatchlistHistory>>;
+  ): Promise<AxiosResponse<WatchHistory>>;
   deleteWatchHistoryForItem(
     mediaId: string
   ): Promise<AxiosResponse<CommonResponse>>;