@irohalab/mira-sdk-angular 1.15.0 → 3.0.0

package/api/default.serviceInterface.d.ts

@@ -1,230 +0,0 @@
-/**
- * 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 } from '@angular/common/http';
-import { Observable } from 'rxjs';
-import { BatchGetMainItemByIdListResult } from '../model/models';
-import { BatchGetSubItemByIdListResult } from '../model/models';
-import { CharacterRelationsWithMainItems } from '../model/models';
-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 { GetFavoriteResponse } from '../model/models';
-import { GetOnAirItemListResponse } from '../model/models';
-import { IdListRequestBody } from '../model/models';
-import { ItemRelationsWithMainItems } from '../model/models';
-import { ListFavoritesResponse } from '../model/models';
-import { ListMainItemResponse } from '../model/models';
-import { ListSubItemFavoriteResponse } from '../model/models';
-import { MainItem } from '../model/models';
-import { PatchFavoriteBody } from '../model/models';
-import { PersonRelationsWithMainItems } from '../model/models';
-import { SubItem } from '../model/models';
-import { SubItemFavorite } from '../model/models';
-import { SucceedEmptyResponse } from '../model/models';
-import { SyncFavoritesRequestBody } from '../model/models';
-import { SyncFavoritesResponse } from '../model/models';
-import { MiraConfiguration } from '../configuration';
-export interface DefaultMiraInterface {
-    defaultHeaders: HttpHeaders;
-    configuration: MiraConfiguration;
-    /**
-     *
-     * 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
-     */
-    getFavoriteProgressByMainItemId(mainItemId: string, epType: number, extraHttpRequestParams?: any): Observable<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
-     */
-    getMainItemById(id: string, coverImage?: string, subItems?: string, extraHttpRequestParams?: any): Observable<MainItem>;
-    /**
-     *
-     * 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
-     * @param orderBy
-     * @param sort
-     */
-    listFavorites(status: string, offset?: number, limit?: number, orderBy?: string, sort?: string, extraHttpRequestParams?: any): Observable<ListFavoritesResponse>;
-    /**
-     *
-     * list MainItems
-     * @endpoint get /public/item/main
-     * @param serviceClientId
-     * @param mainType
-     * @param type
-     * @param subType
-     * @param offset
-     * @param limit
-     * @param orderBy
-     * @param sort
-     * @param keyword
-     */
-    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
-     * @endpoint get /favorite/sub
-     * @param itemId itemId of the SubItem, if provided then other parameters are ignored
-     * @param offset
-     * @param limit
-     * @param orderBy
-     * @param sort
-     * @param subItem
-     */
-    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
-     * @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
-     */
-    patchFavorite(id: string, PatchFavoriteBody: PatchFavoriteBody, extraHttpRequestParams?: any): Observable<SucceedEmptyResponse>;
-    /**
-     *
-     * 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
-     */
-    updateFavoriteProgress(mainItemId: string, progress: number, epType: number, extraHttpRequestParams?: any): Observable<SucceedEmptyResponse>;
-}

package/api.base.service.d.ts

@@ -1,21 +0,0 @@
-/**
- * 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/api.module.d.ts

@@ -1,11 +0,0 @@
-import { ModuleWithProviders } from '@angular/core';
-import { MiraConfiguration } from './configuration';
-import { HttpClient } from '@angular/common/http';
-import * as i0 from "@angular/core";
-export declare class MiraApiModule {
-    static forRoot(configurationFactory: () => MiraConfiguration): ModuleWithProviders<MiraApiModule>;
-    constructor(parentModule: MiraApiModule, http: HttpClient);
-    static ɵfac: i0.ɵɵFactoryDeclaration<MiraApiModule, [{ optional: true; skipSelf: true; }, { optional: true; }]>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<MiraApiModule, never, never, never>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<MiraApiModule>;
-}

package/configuration.d.ts

@@ -1,107 +0,0 @@
-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
-     */
-    apiKeys?: {
-        [key: string]: string;
-    };
-    username?: string;
-    password?: string;
-    /**
-     *  @deprecated Since 5.0. Use credentials instead
-     */
-    accessToken?: string | (() => string);
-    basePath?: string;
-    withCredentials?: boolean;
-    /**
-     * Takes care of encoding query- and form-parameters.
-     */
-    encoder?: HttpParameterCodec;
-    /**
-     * Override the default method for encoding path parameters in various
-     * <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-values">styles</a>.
-     * <p>
-     * See {@link README.md} for more details
-     * </p>
-     */
-    encodeParam?: (param: Param) => string;
-    /**
-     * The keys are the names in the securitySchemes section of the OpenAPI
-     * document. They should map to the value used for authentication
-     * minus any standard prefixes such as 'Basic' or 'Bearer'.
-     */
-    credentials?: {
-        [key: string]: string | (() => string | undefined);
-    };
-}
-export declare class MiraConfiguration {
-    /**
-     *  @deprecated Since 5.0. Use credentials instead
-     */
-    apiKeys?: {
-        [key: string]: string;
-    };
-    username?: string;
-    password?: string;
-    /**
-     *  @deprecated Since 5.0. Use credentials instead
-     */
-    accessToken?: string | (() => string);
-    basePath?: string;
-    withCredentials?: boolean;
-    /**
-     * Takes care of encoding query- and form-parameters.
-     */
-    encoder?: HttpParameterCodec;
-    /**
-     * Encoding of various path parameter
-     * <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-values">styles</a>.
-     * <p>
-     * See {@link README.md} for more details
-     * </p>
-     */
-    encodeParam: (param: Param) => string;
-    /**
-     * The keys are the names in the securitySchemes section of the OpenAPI
-     * document. They should map to the value used for authentication
-     * minus any standard prefixes such as 'Basic' or 'Bearer'.
-     */
-    credentials: {
-        [key: string]: string | (() => string | undefined);
-    };
-    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.
-     * If no content type is found return the first found type if the contentTypes is not empty
-     * @param contentTypes - the array of content types that are available for selection
-     * @returns the selected content-type or <code>undefined</code> if no selection could be made.
-     */
-    selectHeaderContentType(contentTypes: string[]): string | undefined;
-    /**
-     * Select the correct accept content-type to use for a request.
-     * Uses {@link MiraConfiguration#isJsonMime} to determine the correct accept content-type.
-     * If no content type is found return the first found type if the contentTypes is not empty
-     * @param accepts - the array of content types that are available for selection.
-     * @returns the selected content-type or <code>undefined</code> if no selection could be made.
-     */
-    selectHeaderAccept(accepts: string[]): string | undefined;
-    /**
-     * Check if the given MIME is a JSON MIME.
-     * JSON MIME examples:
-     *   application/json
-     *   application/json; charset=UTF8
-     *   APPLICATION/JSON
-     *   application/vnd.company+json
-     * @param mime - MIME (Multipurpose Internet Mail Extensions)
-     * @return True if the given MIME is JSON, false otherwise.
-     */
-    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

@@ -1,17 +0,0 @@
-import { HttpParameterCodec } from '@angular/common/http';
-/**
- * Custom HttpParameterCodec
- * Workaround for https://github.com/angular/angular/issues/18261
- */
-export declare class CustomHttpParameterCodec implements HttpParameterCodec {
-    encodeKey(k: string): string;
-    encodeValue(v: string): string;
-    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;
-}

package/index.d.ts

@@ -1,7 +0,0 @@
-export * from './api/api';
-export * from './model/models';
-export * from './variables';
-export * from './configuration';
-export * from './api.module';
-export * from './provide-api';
-export * from './param';

package/model/batchGetMainItemByIdListResult.d.ts

@@ -1,13 +0,0 @@
-/**
- * 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 { MainItem } from './mainItem';
-export interface BatchGetMainItemByIdListResult {
-    data: Array<MainItem>;
-}

package/model/batchGetSubItemByIdListResult.d.ts

@@ -1,13 +0,0 @@
-/**
- * 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 { SubItem } from './subItem';
-export interface BatchGetSubItemByIdListResult {
-    data: Array<SubItem>;
-}

package/model/characterRelationsWithMainItems.d.ts

@@ -1,15 +0,0 @@
-/**
- * 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 { MainItemBasic } from './mainItemBasic';
-import { ItemCastCharacterRelation } from './itemCastCharacterRelation';
-export interface CharacterRelationsWithMainItems {
-    mainItems: Array<MainItemBasic>;
-    relatedItems: Array<ItemCastCharacterRelation>;
-}

package/model/clientMapping.d.ts

@@ -1,15 +0,0 @@
-/**
- * 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 { MainItem } from './mainItem';
-export interface ClientMapping {
-    id: string;
-    clientId: string;
-    item: MainItem;
-}

package/model/createSubItemFavoriteRequestBody.d.ts

@@ -1,12 +0,0 @@
-/**
- * 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.
- */
-export interface CreateSubItemFavoriteRequestBody {
-    subItemId: string;
-}

package/model/deleteClientMappingByMainItemResponse.d.ts

@@ -1,15 +0,0 @@
-/**
- * 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.
- */
-export interface DeleteClientMappingByMainItemResponse {
-    /**
-     * how many entries are deleted, 1 is successful, 0 is unsuccessful.
-     */
-    data: number;
-}

package/model/errorResponse.d.ts

@@ -1,13 +0,0 @@
-/**
- * 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.
- */
-export interface ErrorResponse {
-    message?: string;
-    status?: number;
-}

package/model/favorite.d.ts

@@ -1,21 +0,0 @@
-/**
- * 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 { FavoriteStatus } from './favoriteStatus';
-import { MainItem } from './mainItem';
-export interface Favorite {
-    readonly id?: string;
-    status: FavoriteStatus;
-    reviewComment?: string;
-    rating?: number;
-    item: MainItem;
-    userId: string;
-}
-export declare namespace Favorite {
-}

package/model/favoriteProgress.d.ts

@@ -1,12 +0,0 @@
-/**
- * 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.
- */
-export interface FavoriteProgress {
-    progress: number;
-}

package/model/favoriteStatus.d.ts

@@ -1,17 +0,0 @@
-/**
- * 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.
- */
-export declare const FavoriteStatus: {
-    readonly Planned: "Planned";
-    readonly Watched: "Watched";
-    readonly Watching: "Watching";
-    readonly OnHold: "OnHold";
-    readonly Dropped: "Dropped";
-};
-export type FavoriteStatus = typeof FavoriteStatus[keyof typeof FavoriteStatus];

package/model/getFavoriteResponse.d.ts

@@ -1,13 +0,0 @@
-/**
- * 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 { Favorite } from './favorite';
-export interface GetFavoriteResponse {
-    data?: Favorite;
-}

package/model/getOnAirItemListResponse.d.ts

@@ -1,16 +0,0 @@
-/**
- * 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 { OnAirItem } from './onAirItem';
-export interface GetOnAirItemListResponse {
-    /**
-     * a list of OnAirItems
-     */
-    data: Array<OnAirItem>;
-}

package/model/idListRequestBody.d.ts

@@ -1,12 +0,0 @@
-/**
- * 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.
- */
-export interface IdListRequestBody {
-    ids: Array<string>;
-}

package/model/imageInfo.d.ts

@@ -1,19 +0,0 @@
-/**
- * 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.
- */
-/**
- * image information
- */
-export interface ImageInfo {
-    id: string;
-    url: string;
-    width: number;
-    height: number;
-    dormantColor: string;
-}

package/model/itemCastCharacterRelation.d.ts

@@ -1,24 +0,0 @@
-/**
- * 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.
- */
-/**
- * represent the relation among the Item type, Person type and Character type MainItems, it can also only be Item and Character type relation.
- */
-export interface ItemCastCharacterRelation {
-    id: string;
-    mainItemId: string;
-    mainItemBgmId: number;
-    relatedCastId?: string | null;
-    relatedCastBgmId: number | null;
-    relatedCharacterId?: string | null;
-    relatedCharacterBgmId: number;
-    characterType: string;
-    isLocked: boolean;
-    relationType?: string;
-}

package/model/itemEntity.d.ts

@@ -1,23 +0,0 @@
-/**
- * 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 { PropertyValue } from './propertyValue';
-export interface ItemEntity {
-    id: string;
-    bgmId: number;
-    /**
-     * Not used for ItemType.Individual and ItemType.Character
-     */
-    publicTime?: string;
-    name?: string;
-    nameCn?: string;
-    properties: {
-        [key: string]: PropertyValue;
-    };
-}