@irohalab/mira-sdk-angular 1.14.0 → 1.15.0

package/README.md

@@ -1,160 +1,112 @@
 # MiraSdkAngular
 
-This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 18.2.0.
+This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 19.2.26.
 
 #### General usage
 
 In your Angular project:
 
+```typescript
 
-```
-// without configuring providers
-import { MiraApiModule } from '';
-import { HttpClientModule } from '@angular/common/http';
-
-@NgModule({
-    imports: [
-        MiraApiModule,
-        // make sure to import the HttpClientModule in the AppModule only,
-        // see https://github.com/angular/angular/issues/20575
-        HttpClientModule
-    ],
-    declarations: [ AppComponent ],
-    providers: [],
-    bootstrap: [ AppComponent ]
-})
-export class AppModule {}
-```
-
-```
-// configuring providers
-import { MiraApiModule, MiraConfiguration, MiraConfigurationParameters } from '';
-
-export function apiConfigFactory (): MiraConfiguration {
-  const params: MiraConfigurationParameters = {
-    // set configuration parameters here.
-  }
-  return new MiraConfiguration(params);
-}
-
-@NgModule({
-    imports: [ MiraApiModule.forRoot(apiConfigFactory) ],
-    declarations: [ AppComponent ],
-    providers: [],
-    bootstrap: [ AppComponent ]
-})
-export class AppModule {}
-```
-
-```
-// configuring providers with an authentication service that manages your access tokens
-import { MiraApiModule, MiraConfiguration } from '';
+import { ApplicationConfig } from '@angular/core';
+import { provideHttpClient } from '@angular/common/http';
+import { provideApi } from '';
 
-@NgModule({
-    imports: [ MiraApiModule ],
-    declarations: [ AppComponent ],
+export const appConfig: ApplicationConfig = {
     providers: [
-      {
-        provide: MiraConfiguration,
-        useFactory: (authService: AuthService) => new MiraConfiguration(
-          {
-            basePath: environment.apiUrl,
-            accessToken: authService.getAccessToken.bind(authService)
-          }
-        ),
-        deps: [AuthService],
-        multi: false
-      }
+        // ...
+        provideHttpClient(),
+        provideApi()
     ],
-    bootstrap: [ AppComponent ]
-})
-export class AppModule {}
-```
-
+};
 ```
-import { DefaultApi } from '';
 
-export class AppComponent {
-    constructor(private apiGateway: DefaultApi) { }
-}
+**NOTE**
+If you're still using `AppModule` and haven't [migrated](https://angular.dev/reference/migrations/standalone) yet, you can still import an Angular module:
+```typescript
+import { MiraApiModule } from '';
 ```
 
-Note: The MiraApiModule is restricted to being instantiated once app wide.
-This is to ensure that all services are treated as singletons.
-
-#### Using multiple OpenAPI files / APIs / MiraApiModules
-In order to use multiple `MiraApiModules` generated from different OpenAPI files,
-you can create an alias name when importing the modules
-in order to avoid naming conflicts:
-```
-import { MiraApiModule } from 'my-api-path';
-import { MiraApiModule as OtherApiModule } from 'my-other-api-path';
-import { HttpClientModule } from '@angular/common/http';
+If different from the generated base path, during app bootstrap, you can provide the base path to your service.
 
-@NgModule({
-  imports: [
-    MiraApiModule,
-    OtherApiModule,
-    // make sure to import the HttpClientModule in the AppModule only,
-    // see https://github.com/angular/angular/issues/20575
-    HttpClientModule
-  ]
-})
-export class AppModule {
+```typescript
+import { ApplicationConfig } from '@angular/core';
+import { provideHttpClient } from '@angular/common/http';
+import { provideApi } from '';
 
-}
+export const appConfig: ApplicationConfig = {
+    providers: [
+        // ...
+        provideHttpClient(),
+        provideApi('http://localhost:9999')
+    ],
+};
 ```
 
+```typescript
+// with a custom configuration
+import { ApplicationConfig } from '@angular/core';
+import { provideHttpClient } from '@angular/common/http';
+import { provideApi } from '';
 
-### Set service base path
-If different than the generated base path, during app bootstrap, you can provide the base path to your service.
-
-```
-import { BASE_PATH } from '';
-
-bootstrap(AppComponent, [
-    { provide: BASE_PATH, useValue: 'https://your-web-service.com' },
-]);
+export const appConfig: ApplicationConfig = {
+    providers: [
+        // ...
+        provideHttpClient(),
+        provideApi({
+            withCredentials: true,
+            username: 'user',
+            password: 'password'
+        })
+    ],
+};
 ```
-or
 
-```
-import { BASE_PATH } from '';
+```typescript
+// with factory building a custom configuration
+import { ApplicationConfig } from '@angular/core';
+import { provideHttpClient } from '@angular/common/http';
+import { provideApi, MiraConfiguration } from '';
 
-@NgModule({
-    imports: [],
-    declarations: [ AppComponent ],
-    providers: [ provide: BASE_PATH, useValue: 'https://your-web-service.com' ],
-    bootstrap: [ AppComponent ]
-})
-export class AppModule {}
+export const appConfig: ApplicationConfig = {
+    providers: [
+        // ...
+        provideHttpClient(),
+        {
+            provide: MiraConfiguration,
+            useFactory: (authService: AuthService) => new MiraConfiguration({
+                    basePath: 'http://localhost:9999',
+                    withCredentials: true,
+                    username: authService.getUsername(),
+                    password: authService.getPassword(),
+            }),
+            deps: [AuthService],
+            multi: false
+        }
+    ],
+};
 ```
 
+### Using multiple OpenAPI files / APIs
 
-#### Using @angular/cli
-First extend your `src/environments/*.ts` files by adding the corresponding base path:
-
-```
-export const environment = {
-  production: false,
-  API_BASE_PATH: 'http://127.0.0.1:8080'
-};
-```
+In order to use multiple APIs generated from different OpenAPI files,
+you can create an alias name when importing the modules
+in order to avoid naming conflicts:
 
-In the src/app/app.module.ts:
-```
-import { BASE_PATH } from '';
+```typescript
+import { provideApi as provideUserApi } from 'my-user-api-path';
+import { provideApi as provideAdminApi } from 'my-admin-api-path';
+import { HttpClientModule } from '@angular/common/http';
 import { environment } from '../environments/environment';
 
-@NgModule({
-  declarations: [
-    AppComponent
-  ],
-  imports: [ ],
-  providers: [{ provide: BASE_PATH, useValue: environment.API_BASE_PATH }],
-  bootstrap: [ AppComponent ]
-})
-export class AppModule { }
+export const appConfig: ApplicationConfig = {
+    providers: [
+        // ...
+        provideHttpClient(),
+        provideUserApi(environment.basePath),
+        provideAdminApi(environment.basePath),
+    ],
+};
 ```
 
 ### Customizing path parameter encoding
@@ -170,9 +122,10 @@ pass an arrow-function or method-reference to the `encodeParam` property of the
 (see [General Usage](#general-usage) above).
 
 Example value for use in your Configuration-Provider:
+
 ```typescript
 new Configuration({
-    encodeParam: (param: Param) => myFancyParamEncoder(param),
+  encodeParam: (param: Param) => myFancyParamEncoder(param),
 })
 ```
 

package/api/default.service.d.ts

@@ -1,4 +1,4 @@
-import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
+import { HttpClient, HttpResponse, HttpEvent, HttpContext } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { BatchGetMainItemByIdListResult } from '../model/batchGetMainItemByIdListResult';
 import { BatchGetSubItemByIdListResult } from '../model/batchGetSubItemByIdListResult';
@@ -8,6 +8,7 @@ import { CreateSubItemFavoriteRequestBody } from '../model/createSubItemFavorite
 import { DeleteClientMappingByMainItemResponse } from '../model/deleteClientMappingByMainItemResponse';
 import { Favorite } from '../model/favorite';
 import { FavoriteProgress } from '../model/favoriteProgress';
+import { GetFavoriteResponse } from '../model/getFavoriteResponse';
 import { GetOnAirItemListResponse } from '../model/getOnAirItemListResponse';
 import { IdListRequestBody } from '../model/idListRequestBody';
 import { ItemRelationsWithMainItems } from '../model/itemRelationsWithMainItems';
@@ -23,22 +24,19 @@ import { SucceedEmptyResponse } from '../model/succeedEmptyResponse';
 import { SyncFavoritesRequestBody } from '../model/syncFavoritesRequestBody';
 import { SyncFavoritesResponse } from '../model/syncFavoritesResponse';
 import { MiraConfiguration } from '../configuration';
+import { BaseService } from '../api.base.service';
 import { DefaultMiraInterface } from './default.serviceInterface';
 import * as i0 from "@angular/core";
-export declare class DefaultMira implements DefaultMiraInterface {
+export declare class DefaultMira extends BaseService implements DefaultMiraInterface {
     protected httpClient: HttpClient;
-    protected basePath: string;
-    defaultHeaders: HttpHeaders;
-    configuration: MiraConfiguration;
-    encoder: HttpParameterCodec;
-    constructor(httpClient: HttpClient, basePath: string | string[], configuration: MiraConfiguration);
-    private addToHttpParams;
-    private addToHttpParamsRecursive;
+    constructor(httpClient: HttpClient, basePath: string | string[], configuration?: MiraConfiguration);
     /**
      * Add ClientMapping
+     * @endpoint post /client-mapping
      * @param request_body
      * @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.
+     * @param options additional options
      */
     addClientMapping(request_body: Array<string>, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -57,9 +55,11 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<ClientMapping>>;
     /**
      * get mainItems by id list
+     * @endpoint post /client-mapping/batch/main
      * @param IdListRequestBody
      * @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.
+     * @param options additional options
      */
     batchGetMainItemByIdList(IdListRequestBody: IdListRequestBody, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -78,9 +78,11 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<BatchGetMainItemByIdListResult>>;
     /**
      * get SubItems by id list
+     * @endpoint post /client-mapping/batch/subItem
      * @param IdListRequestBody
      * @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.
+     * @param options additional options
      */
     batchGetSubItemsByIdList(IdListRequestBody: IdListRequestBody, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -99,9 +101,11 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<BatchGetSubItemByIdListResult>>;
     /**
      * create a favorite for user and item
+     * @endpoint post /favorite
      * @param Favorite
      * @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.
+     * @param options additional options
      */
     createFavorite(Favorite: Favorite, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -120,9 +124,11 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<Favorite>>;
     /**
      * create a SubItemFavorite
+     * @endpoint post /favorite/sub
      * @param CreateSubItemFavoriteRequestBody
      * @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.
+     * @param options additional options
      */
     createSubItemFavorite(CreateSubItemFavoriteRequestBody: CreateSubItemFavoriteRequestBody, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -141,9 +147,11 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<SubItemFavorite>>;
     /**
      * Delete ClientMapping by MainItem id
+     * @endpoint delete /client-mapping/main/{id}
      * @param id
      * @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.
+     * @param options additional options
      */
     deleteClientMappingByMainItemId(id: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -162,9 +170,11 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<DeleteClientMappingByMainItemResponse>>;
     /**
      * Delete a favorite
+     * @endpoint delete /favorite/{id}
      * @param id
      * @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.
+     * @param options additional options
      */
     deleteFavorite(id: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -183,9 +193,11 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<SucceedEmptyResponse>>;
     /**
      * Delete a SubItemFavorite
+     * @endpoint delete /favorite/sub/{id}
      * @param id
      * @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.
+     * @param options additional options
      */
     deleteSubItemFavorite(id: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -202,11 +214,36 @@ export declare class DefaultMira implements DefaultMiraInterface {
         context?: HttpContext;
         transferCache?: boolean;
     }): Observable<HttpEvent<SucceedEmptyResponse>>;
+    /**
+     * Get a favorite by id
+     * @endpoint get /favorite/{id}
+     * @param id
+     * @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.
+     * @param options additional options
+     */
+    getFavoriteById(id: string, observe?: 'body', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<GetFavoriteResponse>;
+    getFavoriteById(id: string, observe?: 'response', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpResponse<GetFavoriteResponse>>;
+    getFavoriteById(id: string, observe?: 'events', reportProgress?: boolean, options?: {
+        httpHeaderAccept?: 'application/json';
+        context?: HttpContext;
+        transferCache?: boolean;
+    }): Observable<HttpEvent<GetFavoriteResponse>>;
     /**
      * get favorite by MainItem id
+     * @endpoint get /favorite/main/{id}
      * @param id
      * @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.
+     * @param options additional options
      */
     getFavoriteByMainItemId(id: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -225,10 +262,12 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<Favorite>>;
     /**
      * get favorite progress (number of SubItemFavorite from the beginning) of a episode type for mainItem
+     * @endpoint get /favorite/progress
      * @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.
+     * @param options additional options
      */
     getFavoriteProgressByMainItemId(mainItemId: string, epType: number, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -247,11 +286,13 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<FavoriteProgress>>;
     /**
      * get a MainItem by id
+     * @endpoint get /public/item/main/{id}
      * @param id MainItem id
      * @param coverImage populate coverImage if true
      * @param subItems populate subItems if true
      * @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.
+     * @param options additional options
      */
     getMainItemById(id: string, coverImage?: string, subItems?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -270,9 +311,11 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<MainItem>>;
     /**
      * get all related (Item , Cast) MainItem of an Character Type MainItem.
+     * @endpoint get /public/relation/character/{id}
      * @param id MainItem id
      * @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.
+     * @param options additional options
      */
     getRelationsOfCharacter(id: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -291,9 +334,11 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<CharacterRelationsWithMainItems>>;
     /**
      * get all related (Item, Staff, Cast, Character) MainItem of an Item Type MainItem.
+     * @endpoint get /public/relation/item/{id}
      * @param id MainItem id
      * @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.
+     * @param options additional options
      */
     getRelationsOfItem(id: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -312,9 +357,11 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<ItemRelationsWithMainItems>>;
     /**
      * get all related (Item , Character) MainItem of an Person Type MainItem.
+     * @endpoint get /public/relation/person/{id}
      * @param id MainItem id
      * @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.
+     * @param options additional options
      */
     getRelationsOfPerson(id: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -333,9 +380,11 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<PersonRelationsWithMainItems>>;
     /**
      * get a SubItem by id
+     * @endpoint get /public/item/main/subItem/{id}
      * @param id SubItem Id
      * @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.
+     * @param options additional options
      */
     getSubItemById(id: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -354,6 +403,7 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<SubItem>>;
     /**
      * list favorites for user
+     * @endpoint get /favorite
      * @param status
      * @param offset
      * @param limit
@@ -361,6 +411,7 @@ export declare class DefaultMira implements DefaultMiraInterface {
      * @param sort
      * @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.
+     * @param options additional options
      */
     listFavorites(status: string, offset?: number, limit?: number, orderBy?: string, sort?: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -379,6 +430,7 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<ListFavoritesResponse>>;
     /**
      * list MainItems
+     * @endpoint get /public/item/main
      * @param serviceClientId
      * @param mainType
      * @param type
@@ -390,6 +442,7 @@ export declare class DefaultMira implements DefaultMiraInterface {
      * @param keyword
      * @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.
+     * @param options additional 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';
@@ -408,6 +461,7 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<ListMainItemResponse>>;
     /**
      * list SubItemFavorite
+     * @endpoint get /favorite/sub
      * @param itemId itemId of the SubItem, if provided then other parameters are ignored
      * @param offset
      * @param limit
@@ -416,6 +470,7 @@ export declare class DefaultMira implements DefaultMiraInterface {
      * @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.
+     * @param options additional options
      */
     listSubItemFavorites(itemId?: string, offset?: number, limit?: number, orderBy?: string, sort?: string, subItem?: boolean, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -434,9 +489,11 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<ListSubItemFavoriteResponse>>;
     /**
      * get a list of on air MainItems with cover image
+     * @endpoint get /public/item/on-air
      * @param type type of MainItem, must be either anime or real
      * @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.
+     * @param options additional options
      */
     onAirItem(type: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -455,10 +512,12 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<GetOnAirItemListResponse>>;
     /**
      * change status of a favorite
+     * @endpoint patch /favorite/{id}
      * @param id
      * @param PatchFavoriteBody
      * @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.
+     * @param options additional options
      */
     patchFavorite(id: string, PatchFavoriteBody: PatchFavoriteBody, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -477,9 +536,11 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<SucceedEmptyResponse>>;
     /**
      * predict Main Item names base on provided prefix
+     * @endpoint get /public/item/predict
      * @param prefix start part of the name
      * @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.
+     * @param options additional options
      */
     predictMainItemName(prefix: string, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -498,9 +559,11 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<Array<string>>>;
     /**
      * Sync favorites from external source, merge with existing favorites
+     * @endpoint post /favorite/sync
      * @param SyncFavoritesRequestBody
      * @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.
+     * @param options additional options
      */
     syncFavorites(SyncFavoritesRequestBody: SyncFavoritesRequestBody, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';
@@ -519,11 +582,13 @@ export declare class DefaultMira implements DefaultMiraInterface {
     }): Observable<HttpEvent<SyncFavoritesResponse>>;
     /**
      * update progress of a favorite, will create/delete SubItemFavorite
+     * @endpoint post /favorite/progress
      * @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.
+     * @param options additional options
      */
     updateFavoriteProgress(mainItemId: string, progress: number, epType: number, observe?: 'body', reportProgress?: boolean, options?: {
         httpHeaderAccept?: 'application/json';