@irohalab/mira-sdk-angular 1.13.1 → 1.15.0

package/api/default.serviceInterface.d.ts

@@ -1,6 +1,5 @@
 /**
  * mira API
- * API for Project-Mira
  *
  *
  *
@@ -18,6 +17,7 @@ import { CreateSubItemFavoriteRequestBody } from '../model/models';
 import { DeleteClientMappingByMainItemResponse } from '../model/models';
 import { Favorite } from '../model/models';
 import { FavoriteProgress } from '../model/models';
+import { GetFavoriteResponse } from '../model/models';
 import { GetOnAirItemListResponse } from '../model/models';
 import { IdListRequestBody } from '../model/models';
 import { ItemRelationsWithMainItems } from '../model/models';
@@ -39,60 +39,77 @@ export interface DefaultMiraInterface {
     /**
      *
      * Add ClientMapping
+     * @endpoint post /client-mapping
      * @param request_body
      */
     addClientMapping(request_body: Array<string>, extraHttpRequestParams?: any): Observable<ClientMapping>;
     /**
      *
      * get mainItems by id list
+     * @endpoint post /client-mapping/batch/main
      * @param IdListRequestBody
      */
     batchGetMainItemByIdList(IdListRequestBody: IdListRequestBody, extraHttpRequestParams?: any): Observable<BatchGetMainItemByIdListResult>;
     /**
      *
      * get SubItems by id list
+     * @endpoint post /client-mapping/batch/subItem
      * @param IdListRequestBody
      */
     batchGetSubItemsByIdList(IdListRequestBody: IdListRequestBody, extraHttpRequestParams?: any): Observable<BatchGetSubItemByIdListResult>;
     /**
      *
      * create a favorite for user and item
+     * @endpoint post /favorite
      * @param Favorite
      */
     createFavorite(Favorite: Favorite, extraHttpRequestParams?: any): Observable<Favorite>;
     /**
      *
      * create a SubItemFavorite
+     * @endpoint post /favorite/sub
      * @param CreateSubItemFavoriteRequestBody
      */
     createSubItemFavorite(CreateSubItemFavoriteRequestBody: CreateSubItemFavoriteRequestBody, extraHttpRequestParams?: any): Observable<SubItemFavorite>;
     /**
      *
      * Delete ClientMapping by MainItem id
+     * @endpoint delete /client-mapping/main/{id}
      * @param id
      */
     deleteClientMappingByMainItemId(id: string, extraHttpRequestParams?: any): Observable<DeleteClientMappingByMainItemResponse>;
     /**
      *
      * Delete a favorite
+     * @endpoint delete /favorite/{id}
      * @param id
      */
     deleteFavorite(id: string, extraHttpRequestParams?: any): Observable<SucceedEmptyResponse>;
     /**
      *
      * Delete a SubItemFavorite
+     * @endpoint delete /favorite/sub/{id}
      * @param id
      */
     deleteSubItemFavorite(id: string, extraHttpRequestParams?: any): Observable<SucceedEmptyResponse>;
+    /**
+     *
+     * Get a favorite by id
+     * @endpoint get /favorite/{id}
+     * @param id
+     */
+    getFavoriteById(id: string, extraHttpRequestParams?: any): Observable<GetFavoriteResponse>;
     /**
      *
      * get favorite by MainItem id
+     * @endpoint get /favorite/main/{id}
      * @param id
      */
     getFavoriteByMainItemId(id: string, extraHttpRequestParams?: any): Observable<Favorite>;
     /**
      *
      * get favorite progress (number of SubItemFavorite from the beginning) of a episode type for mainItem
+     * @endpoint get /favorite/progress
      * @param mainItemId
      * @param epType
      */
@@ -100,6 +117,7 @@ export interface DefaultMiraInterface {
     /**
      *
      * 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
@@ -108,30 +126,35 @@ export interface DefaultMiraInterface {
     /**
      *
      * get all related (Item , Cast) MainItem of an Character Type MainItem.
+     * @endpoint get /public/relation/character/{id}
      * @param id MainItem id
      */
     getRelationsOfCharacter(id: string, extraHttpRequestParams?: any): Observable<CharacterRelationsWithMainItems>;
     /**
      *
      * get all related (Item, Staff, Cast, Character) MainItem of an Item Type MainItem.
+     * @endpoint get /public/relation/item/{id}
      * @param id MainItem id
      */
     getRelationsOfItem(id: string, extraHttpRequestParams?: any): Observable<ItemRelationsWithMainItems>;
     /**
      *
      * get all related (Item , Character) MainItem of an Person Type MainItem.
+     * @endpoint get /public/relation/person/{id}
      * @param id MainItem id
      */
     getRelationsOfPerson(id: string, extraHttpRequestParams?: any): Observable<PersonRelationsWithMainItems>;
     /**
      *
      * get a SubItem by id
+     * @endpoint get /public/item/main/subItem/{id}
      * @param id SubItem Id
      */
     getSubItemById(id: string, extraHttpRequestParams?: any): Observable<SubItem>;
     /**
      *
      * list favorites for user
+     * @endpoint get /favorite
      * @param status
      * @param offset
      * @param limit
@@ -142,6 +165,7 @@ export interface DefaultMiraInterface {
     /**
      *
      * list MainItems
+     * @endpoint get /public/item/main
      * @param serviceClientId
      * @param mainType
      * @param type
@@ -156,6 +180,7 @@ export interface DefaultMiraInterface {
     /**
      *
      * list SubItemFavorite
+     * @endpoint get /favorite/sub
      * @param itemId itemId of the SubItem, if provided then other parameters are ignored
      * @param offset
      * @param limit
@@ -167,12 +192,14 @@ export interface DefaultMiraInterface {
     /**
      *
      * 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
      */
     onAirItem(type: string, extraHttpRequestParams?: any): Observable<GetOnAirItemListResponse>;
     /**
      *
      * change status of a favorite
+     * @endpoint patch /favorite/{id}
      * @param id
      * @param PatchFavoriteBody
      */
@@ -180,18 +207,21 @@ export interface DefaultMiraInterface {
     /**
      *
      * predict Main Item names base on provided prefix
+     * @endpoint get /public/item/predict
      * @param prefix start part of the name
      */
     predictMainItemName(prefix: string, extraHttpRequestParams?: any): Observable<Array<string>>;
     /**
      *
      * Sync favorites from external source, merge with existing favorites
+     * @endpoint post /favorite/sync
      * @param SyncFavoritesRequestBody
      */
     syncFavorites(SyncFavoritesRequestBody: SyncFavoritesRequestBody, extraHttpRequestParams?: any): Observable<SyncFavoritesResponse>;
     /**
      *
      * update progress of a favorite, will create/delete SubItemFavorite
+     * @endpoint post /favorite/progress
      * @param mainItemId
      * @param progress
      * @param epType

package/api.base.service.d.ts

@@ -0,0 +1,21 @@
+/**
+ * mira API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { HttpHeaders, HttpParameterCodec } from '@angular/common/http';
+import { MiraConfiguration } from './configuration';
+import { OpenApiHttpParams, QueryParamStyle } from './query.params';
+export declare class BaseService {
+    protected basePath: string;
+    defaultHeaders: HttpHeaders;
+    configuration: MiraConfiguration;
+    encoder: HttpParameterCodec;
+    constructor(basePath?: string | string[], configuration?: MiraConfiguration);
+    protected canConsumeForm(consumes: string[]): boolean;
+    protected addToHttpParams(httpParams: OpenApiHttpParams, key: string, value: any | null | undefined, paramStyle: QueryParamStyle, explode: boolean): OpenApiHttpParams;
+}

package/configuration.d.ts

@@ -1,5 +1,6 @@
-import { HttpParameterCodec } from '@angular/common/http';
+import { HttpHeaders, HttpParameterCodec } from '@angular/common/http';
 import { Param } from './param';
+import { OpenApiHttpParams } from './query.params';
 export interface MiraConfigurationParameters {
     /**
      *  @deprecated Since 5.0. Use credentials instead
@@ -71,7 +72,7 @@ export declare class MiraConfiguration {
     credentials: {
         [key: string]: string | (() => string | undefined);
     };
-    constructor(configurationParameters?: MiraConfigurationParameters);
+    constructor({ accessToken, apiKeys, basePath, credentials, encodeParam, encoder, password, username, withCredentials }?: MiraConfigurationParameters);
     /**
      * Select the correct content-type to use for a request.
      * Uses {@link MiraConfiguration#isJsonMime} to determine the correct content-type.
@@ -100,5 +101,7 @@ export declare class MiraConfiguration {
      */
     isJsonMime(mime: string): boolean;
     lookupCredential(key: string): string | undefined;
+    addCredentialToHeaders(credentialKey: string, headerName: string, headers: HttpHeaders, prefix?: string): HttpHeaders;
+    addCredentialToQuery(credentialKey: string, paramName: string, query: OpenApiHttpParams): OpenApiHttpParams;
     private defaultEncodeParam;
 }

package/encoder.d.ts

@@ -9,3 +9,9 @@ export declare class CustomHttpParameterCodec implements HttpParameterCodec {
     decodeKey(k: string): string;
     decodeValue(v: string): string;
 }
+export declare class IdentityHttpParameterCodec implements HttpParameterCodec {
+    encodeKey(k: string): string;
+    encodeValue(v: string): string;
+    decodeKey(k: string): string;
+    decodeValue(v: string): string;
+}