@irohalab/mira-sdk-angular 1.6.2 → 1.8.0

package/api/default.service.d.ts

@@ -6,6 +6,7 @@ import { ClientMapping } from '../model/clientMapping';
 import { CreateSubItemFavoriteRequestBody } from '../model/createSubItemFavoriteRequestBody';
 import { DeleteClientMappingByMainItemResponse } from '../model/deleteClientMappingByMainItemResponse';
 import { Favorite } from '../model/favorite';
+import { FavoriteProgress } from '../model/favoriteProgress';
 import { GetOnAirItemListResponse } from '../model/getOnAirItemListResponse';
 import { IdListRequestBody } from '../model/idListRequestBody';
 import { ListFavoritesResponse } from '../model/listFavoritesResponse';
@@ -217,6 +218,28 @@ export declare class DefaultMira implements DefaultMiraInterface {
         context?: HttpContext;
         transferCache?: boolean;
     }): Observable<HttpEvent<Favorite>>;
+    /**
+     * get favorite progress (number of SubItemFavorite from the beginning) of a episode type for mainItem
+     * @param mainItemId
+     * @param epType
+     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+     * @param reportProgress flag to report request and response progress.
+     */
+    getFavoriteProgressByMainItemId(mainItemId: string, epType: number, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<FavoriteProgress>;
+    getFavoriteProgressByMainItemId(mainItemId: string, epType: number, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<FavoriteProgress>>;
+    getFavoriteProgressByMainItemId(mainItemId: string, epType: number, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<FavoriteProgress>>;
     /**
      * get a MainItem by id
      * @param id MainItem id
@@ -288,6 +311,7 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<ListFavoritesResponse>>;
     /**
      * list MainItems
+     * @param serviceClientId
      * @param mainType
      * @param type
      * @param subType
@@ -299,17 +323,17 @@ export declare class DefaultMira implements DefaultMiraInterface {
      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
      * @param reportProgress flag to report request and response progress.
      */
-    listMainItems(mainType: string, type?: string, subType?: string, offset?: number, limit?: number, orderBy?: string, sort?: string, keyword?: string, observe?: 'body', reportProgress?: boolean, options?: {
+    listMainItems(serviceClientId?: string, mainType?: string, type?: string, subType?: string, offset?: number, limit?: number, orderBy?: string, sort?: string, keyword?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
     }): Observable<ListMainItemResponse>;
-    listMainItems(mainType: string, type?: string, subType?: string, offset?: number, limit?: number, orderBy?: string, sort?: string, keyword?: string, observe?: 'response', reportProgress?: boolean, options?: {
+    listMainItems(serviceClientId?: string, mainType?: string, type?: string, subType?: string, offset?: number, limit?: number, orderBy?: string, sort?: string, keyword?: string, observe?: 'response', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
     }): Observable<HttpResponse<ListMainItemResponse>>;
-    listMainItems(mainType: string, type?: string, subType?: string, offset?: number, limit?: number, orderBy?: string, sort?: string, keyword?: string, observe?: 'events', reportProgress?: boolean, options?: {
+    listMainItems(serviceClientId?: string, mainType?: string, type?: string, subType?: string, offset?: number, limit?: number, orderBy?: string, sort?: string, keyword?: string, observe?: 'events', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
@@ -321,20 +345,21 @@ export declare class DefaultMira implements DefaultMiraInterface {
      * @param limit
      * @param orderBy
      * @param sort
+     * @param subItem
      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
      * @param reportProgress flag to report request and response progress.
      */
-    listSubItemFavorites(itemId?: string, offset?: number, limit?: number, orderBy?: string, sort?: string, observe?: 'body', reportProgress?: boolean, options?: {
+    listSubItemFavorites(itemId?: string, offset?: number, limit?: number, orderBy?: string, sort?: string, subItem?: boolean, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
     }): Observable<ListSubItemFavoriteResponse>;
-    listSubItemFavorites(itemId?: string, offset?: number, limit?: number, orderBy?: string, sort?: string, observe?: 'response', reportProgress?: boolean, options?: {
+    listSubItemFavorites(itemId?: string, offset?: number, limit?: number, orderBy?: string, sort?: string, subItem?: boolean, observe?: 'response', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
     }): Observable<HttpResponse<ListSubItemFavoriteResponse>>;
-    listSubItemFavorites(itemId?: string, offset?: number, limit?: number, orderBy?: string, sort?: string, observe?: 'events', reportProgress?: boolean, options?: {
+    listSubItemFavorites(itemId?: string, offset?: number, limit?: number, orderBy?: string, sort?: string, subItem?: boolean, observe?: 'events', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
         context?: HttpContext;
         transferCache?: boolean;
@@ -403,6 +428,29 @@ export declare class DefaultMira implements DefaultMiraInterface {
         context?: HttpContext;
         transferCache?: boolean;
     }): Observable<HttpEvent<Array<string>>>;
+    /**
+     * update progress of a favorite, will create/delete SubItemFavorite
+     * @param mainItemId
+     * @param progress
+     * @param epType
+     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+     * @param reportProgress flag to report request and response progress.
+     */
+    updateFavoriteProgress(mainItemId: string, progress: number, epType: number, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<SucceedEmptyResponse>;
+    updateFavoriteProgress(mainItemId: string, progress: number, epType: number, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<SucceedEmptyResponse>>;
+    updateFavoriteProgress(mainItemId: string, progress: number, epType: number, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<SucceedEmptyResponse>>;
     static ɵfac: i0.ɵɵFactoryDeclaration<DefaultMira, [null, { optional: true; }, { optional: true; }]>;
     static ɵprov: i0.ɵɵInjectableDeclaration<DefaultMira>;
 }

package/api/default.serviceInterface.d.ts

@@ -16,6 +16,7 @@ import { ClientMapping } from '../model/models';
 import { CreateSubItemFavoriteRequestBody } from '../model/models';
 import { DeleteClientMappingByMainItemResponse } from '../model/models';
 import { Favorite } from '../model/models';
+import { FavoriteProgress } from '../model/models';
 import { GetOnAirItemListResponse } from '../model/models';
 import { IdListRequestBody } from '../model/models';
 import { ListFavoritesResponse } from '../model/models';
@@ -84,6 +85,13 @@ export interface DefaultMiraInterface {
      * @param id
      */
     getFavoriteByMainItemId(id: string, extraHttpRequestParams?: any): Observable<Favorite>;
+    /**
+     *
+     * get favorite progress (number of SubItemFavorite from the beginning) of a episode type for mainItem
+     * @param mainItemId
+     * @param epType
+     */
+    getFavoriteProgressByMainItemId(mainItemId: string, epType: number, extraHttpRequestParams?: any): Observable<FavoriteProgress>;
     /**
      *
      * get a MainItem by id
@@ -111,6 +119,7 @@ export interface DefaultMiraInterface {
     /**
      *
      * list MainItems
+     * @param serviceClientId
      * @param mainType
      * @param type
      * @param subType
@@ -120,7 +129,7 @@ export interface DefaultMiraInterface {
      * @param sort
      * @param keyword
      */
-    listMainItems(mainType: string, type?: string, subType?: string, offset?: number, limit?: number, orderBy?: string, sort?: string, keyword?: string, extraHttpRequestParams?: any): Observable<ListMainItemResponse>;
+    listMainItems(serviceClientId?: string, mainType?: string, type?: string, subType?: string, offset?: number, limit?: number, orderBy?: string, sort?: string, keyword?: string, extraHttpRequestParams?: any): Observable<ListMainItemResponse>;
     /**
      *
      * list SubItemFavorite
@@ -129,8 +138,9 @@ export interface DefaultMiraInterface {
      * @param limit
      * @param orderBy
      * @param sort
+     * @param subItem
      */
-    listSubItemFavorites(itemId?: string, offset?: number, limit?: number, orderBy?: string, sort?: string, extraHttpRequestParams?: any): Observable<ListSubItemFavoriteResponse>;
+    listSubItemFavorites(itemId?: string, offset?: number, limit?: number, orderBy?: string, sort?: string, subItem?: boolean, extraHttpRequestParams?: any): Observable<ListSubItemFavoriteResponse>;
     /**
      *
      * get a list of on air MainItems with cover image
@@ -150,4 +160,12 @@ export interface DefaultMiraInterface {
      * @param prefix start part of the name
      */
     predictMainItemName(prefix: string, extraHttpRequestParams?: any): Observable<Array<string>>;
+    /**
+     *
+     * update progress of a favorite, will create/delete SubItemFavorite
+     * @param mainItemId
+     * @param progress
+     * @param epType
+     */
+    updateFavoriteProgress(mainItemId: string, progress: number, epType: number, extraHttpRequestParams?: any): Observable<SucceedEmptyResponse>;
 }