anixartjs 0.0.9 → 0.1.1

package/dist/api/profile.js

@@ -4,59 +4,434 @@ exports.Profile = void 0;
 /**
  * Класс профиля
  *
- * TODO: changeAvatar
+ * TODO: Понять для чего нужен эндпоинт '/profile/process/{id}' - POST
+ * Пока что предположение что это что-то для модерации
  */
 class Profile {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * Получение информация о профиле по его ID
+     *
+     * Возвращает {@link IProfileResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param id - ID Профиля
+     * @param options - Дополнительные параметры
+     * @returns Информацию о профиле с указанным ID
+     *
+     * @example
+     * const result = await client.endpoints.profile.info(1);
+     */
     async info(id, options) {
         return this.client.call({ path: `/profile/${id}`, ...options });
     }
+    /**
+     * Получение закладок из профиля по его ID
+     *
+     * Возвращает {@link IRelease} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param data - Данные для запроса
+     * @param options - Дополнительные параметры
+     * @returns Информацию о релизах которые находятся в закладке
+     *
+     * @example
+     * const { BookmarkType, BookmarkSortType } = require("anixartjs");
+     *
+     * const result = await client.endpoints.profile.getBookmarks({
+     *      type: BookmarkType.Watching,            //Тип закладки
+     *      id: 1,                                  //ID профиля
+     *      sort: BookmarkSortType.NewToOldAddTime, //Сортировка
+     *      page: 0                                 //Страница
+     * });
+     */
     async getBookmarks(data, options) {
         return this.client.call({ path: `/profile/list/all/${data.id ? `${data.id}/` : ""}${data.type}/${data.page}`, queryParams: { sort: data.sort, filter: data.filter, filter_announce: data.filter_announce }, ...options });
     }
+    /**
+     * Добавление релиза в закладку
+     *
+     * Возвращает код результата {@link IResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param id - ID релиза
+     * @param type - Тип закладки {@link BookmarkType}
+     * @param options - Дополнительные параметры
+     * @returns Ответ API в виде числа
+     *
+     * @example
+     * const { BookmarkType } = require("anixartjs");
+     *
+     * const result = await client.endpoints.profile.addBookmarks(1, BookmarkType.Watching);
+     */
     async addBookmark(id, type, options) {
         return this.client.call({ path: `/profile/list/add/${type}/${id}`, ...options });
     }
+    /**
+     * Удаление релиза из закладки
+     *
+     * Возвращает код результата {@link IResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param id - ID релиза
+     * @param type - Тип закладки {@link BookmarkType}
+     * @param options - Дополнительные параметры
+     * @returns Ответ API в виде числа
+     *
+     * @example
+     * const { BookmarkType } = require("anixartjs");
+     *
+     * const result = await client.endpoints.profile.removeBookmarks(1, BookmarkType.Watching);
+     */
     async removeBookmark(id, type, options) {
         return this.client.call({ path: `/profile/list/delete/${type}/${id}`, ...options });
     }
-    async search(data, options) {
-        return this.client.call({ path: `/search/profiles/${data.page}`, json: { query: data.query, page: data.page }, ...options });
-    }
+    /**
+     * Получение друзей профиля по его ID
+     *
+     * Возвращает список {@link IProfileShort} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param data - Данные для получения списка друзей
+     * @param options - Дополнительные параметры
+     * @returns Список друзей
+     *
+     * @example
+     * const result = await client.endpoints.profile.getFriends({
+     *      id: 1,      //ID Профиля
+     *      page: 0     //Страница
+     * });
+     */
     async getFriends(data, options) {
         return await this.client.call({ path: `/profile/friend/all/${data.id}/${data.page}`, ...options });
     }
+    /**
+     * Получение списка рекомендаций для добавления в друзья
+     *
+     * Возвращает список {@link IProfileShort} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param options - Дополнительные параметры
+     * @returns Список потенциальных друзей
+     *
+     * @example
+     * const result = await client.endpoints.profile.getFriendRecomendation();
+     */
     async getFriendRecomendation(options) {
         return await this.client.call({ path: `/profile/friend/recomendations`, ...options });
     }
-    async getFriendRequests(type, count, options) {
+    /**
+     * Получение списка последних заявок в друзья
+     *
+     * Возвращает список {@link IProfileShort} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param type - Тип заявок (Входящие или исходящие)
+     * @param count - Количество заявок
+     * @param options - Дополнительные параметры
+     * @returns Список последних заявок в друзья
+     *
+     * @example
+     * const result = await client.endpoints.profile.getLastFriendRequests("in", 5);
+     */
+    async getLastFriendRequests(type, count, options) {
         return await this.client.call({ path: `/profile/friend/requests/${type}/last`, queryParams: { count }, ...options });
     }
+    /**
+     * Получение списка заявок в друзья
+     *
+     * Возвращает список {@link IProfileShort} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param type - Тип заявок (Входящие или исходящие)
+     * @param page - Номер страницы
+     * @param options - Дополнительные параметры
+     * @returns Список заявок в друзья
+     *
+     * @example
+     * const result = await client.endpoints.profile.getFriendRequests("in", 0);
+     */
+    async getFriendRequests(type, page, options) {
+        return await this.client.call({ path: `/profile/friend/requests/${type}/${page}`, ...options });
+    }
+    /**
+     * Отправка запроса на добавление в друзья
+     *
+     * Возвращает ответ {@link IFriendRequestResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}, {@link SendFriendRequestResult}
+     *
+     * @param id - ID Профиля
+     * @param options - Дополнительные параметры
+     * @returns Статус дружбы
+     *
+     * @example
+     * const result = await client.endpoints.profile.sendFriendRequest(1);
+     */
     async sendFriendRequest(id, options) {
         return await this.client.call({ path: `/profile/friend/request/send/${id}`, ...options });
     }
+    /**
+     * Удаление запроса на добавление в друзья
+     *
+     * Возвращает ответ {@link IFriendRequestResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}, {@link RemoveFriendRequestResult}
+     *
+     * @param id - ID Профиля
+     * @param options - Дополнительные параметры
+     * @returns Статус дружбы
+     *
+     * @example
+     * const result = await client.endpoints.profile.removeFriendRequest(1);
+     */
     async removeFriendRequest(id, options) {
         return await this.client.call({ path: `/profile/friend/request/remove/${id}`, ...options });
     }
+    /**
+     * Скрытие запроса на добавление в друзья
+     *
+     * Возвращает ответ {@link IResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param id - ID Профиля
+     * @param options - Дополнительные параметры
+     * @returns Код ответа
+     *
+     * @example
+     * const result = await client.endpoints.profile.hideFriendRequest(1);
+     */
     async hideFriendRequest(id, options) {
         return await this.client.call({ path: `/profile/friend/request/hide/${id}`, ...options });
     }
+    /**
+     * Получение достижения в профиль
+     *
+     * Возвращает ответ {@link IResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}, {@link AchivementResult}
+     *
+     * @param id - ID Достижения
+     * @param options - Дополнительные параметры
+     * @returns Код ответа
+     *
+     * @example
+     * const result = await client.endpoints.profile.getAchivement("DEMO1-ACHIV-MENT2");
+     * //Или
+     * const result = await client.endpoints.profile.getAchivement(1);
+     */
     async getAchivement(id, options) {
         return await this.client.call({ path: `/achivement/get/${id}`, ...options });
     }
+    /**
+     * Получение избранных релизов в профиле
+     *
+     * Возвращает релизы {@link IRelease} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param data - Данные для запроса
+     * @param options - Дополнительные параметры
+     * @returns Релизы
+     *
+     * @example
+     * const { BookmarkSortType } = require("anixartjs");
+     *
+     * const result = await client.endpoints.profile.getFavorites({
+     *     page: 1,                                 //Страница
+     *     sort: BookmarkSortType.NewToOldAddTime,  //Сортировка
+     *     filter_announce: 0,                      //Фильтр по анонсам
+     * });
+     */
     async getFavorites(data, options) {
         return await this.client.call({ path: `/favorite/all/${data.page}`, queryParams: { sort: data.sort, filter: data.filter, filter_announce: data.filter_announce }, ...options });
     }
+    /**
+     * Получение подписок в профиле на каналы и блоги
+     *
+     * Возвращает каналы и блоги {@link IChannel} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param page - Номер страницы
+     * @param options - Дополнительные параметры
+     * @returns Каналы и блоги
+     *
+     * @example
+     * const result = await client.endpoints.profile.getSubsciptions(0);
+     */
     async getSubsciptions(page, options) {
         return await this.client.call({ path: `/channel/subscription/all/${page}`, ...options });
     }
+    /**
+     * Получение количество подписок в профиле на каналы и блоги
+     *
+     * Возвращает число подписок {@link ISubsciptionCountResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param options - Дополнительные параметры
+     * @returns Число подписок
+     *
+     * @example
+     * const result = await client.endpoints.profile.getSubsciptionCount(0);
+     */
     async getSubscriptionCount(options) {
         return await this.client.call({ path: `/channel/subscription/count`, ...options });
     }
-    async getVotesReleases(id, page, sort = 1, options) {
+    /**
+     * Получение списка оцененных релизов профиля
+     *
+     * Возвращает список {@link IVoteRelease} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param id - ID Профиля
+     * @param page - Номер страницы
+     * @param sort - Сортировка
+     * @param options - Дополнительные параметры
+     * @returns Список оцененных релизов
+     *
+     * @example
+     * const result = await client.endpoints.profile.getVotedReleases(1, 0);
+     */
+    async getVotedReleases(id, page, sort = 1, options) {
         return await this.client.call({ path: `/profile/vote/release/voted/${id}/${page}`, queryParams: { sort }, ...options });
     }
+    /**
+     * Получение списка юзернеймов профиля на другие соц. сети
+     *
+     * Возвращает ответ {@link ISocialResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param id - ID Профиля
+     * @param options - Дополнительные параметры
+     * @returns Список оцененных релизов
+     *
+     * @example
+     * const result = await client.endpoints.profile.getSocials(1);
+     */
+    async getSocials(id, options) {
+        return await this.client.call({ path: `/profile/social/${id}`, ...options });
+    }
+    /**
+     * Получение списка неоцененных релизов профиля (Предположительно которые находятся в закладках профиля)
+     *
+     * Возвращает список {@link IRelease} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param page - Номер страницы
+     * @param options - Дополнительные параметры
+     * @returns Список неоцененных релизов
+     *
+     * @example
+     * const result = await client.endpoints.profile.getUnvotedReleases(0);
+     */
+    async getUnvotedReleases(page = "last", options) {
+        return await this.client.call({ path: `/profile/vote/release/unvoted/${page}`, ...options });
+    }
+    /**
+     * Получение списка профилей у которых есть конкретная роль
+     *
+     * Возвращает список {@link IProfileShort} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param id - ID Роли
+     * @param page - Номер страницы
+     * @param options - Дополнительные параметры
+     * @returns Список профилей у которых есть конкретная роль
+     *
+     * @example
+     * const result = await client.endpoints.profile.getRoleProfiles(0);
+     */
+    async getRoleProfiles(id, page, options) {
+        return await this.client.call({ path: `/role/all/${page}/${id}`, ...options });
+    }
+    /**
+     * Экспорт закладок из профиля
+     *
+     * Возвращает ответ {@link IExportBookmarksResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}, {@link BookmarkExportResult}
+     *
+     * @param listIds - Типы закладок
+     * @param sort - Сортировка
+     * @param options - Дополнительные параметры
+     * @returns Результат экспорта
+     *
+     * @example
+     * const { BookmarkType } = require("anixartjs");
+     *
+     * const bookmarks = [BookmarkType.Watching, BookmarkType.Completed];
+     * const result = await client.endpoints.profile.exportBookmarks(bookmarks);
+     */
+    async exportBookmarks(listIds, sort, options) {
+        return await this.client.call({ path: "/export/bookmarks", json: { bookmarksExportProfileLists: listIds }, queryParams: { sort }, ...options });
+    }
+    /**
+     * Получение списка профилей которые находятся в блоклисте
+     *
+     * Возвращает список {@link IProfile} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param page - Номер страницы
+     * @param options - Дополнительные параметры
+     * @returns Список профилей
+     *
+     * @example
+     * const result = await client.endpoints.profile.getBlocklist(0);
+     */
+    async getBlocklist(page, options) {
+        return await this.client.call({ path: `/profile/blocklist/all/${page}`, ...options });
+    }
+    /**
+     * Добавление профиля в блоклист
+     *
+     * Возвращает ответ {@link IResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param id - ID Профиля
+     * @param options - Дополнительные параметры
+     * @returns Код ответа
+     *
+     * @example
+     * const result = await client.endpoints.profile.addToBlocklist(1);
+     */
+    async addToBlocklist(id, options) {
+        return await this.client.call({ path: `/profile/blocklist/add/${id}`, ...options });
+    }
+    /**
+     * Удаление профиля из блоклиста
+     *
+     * Возвращает ответ {@link IResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param id - ID Профиля
+     * @param options - Дополнительные параметры
+     * @returns Код ответа
+     *
+     * @example
+     * const result = await client.endpoints.profile.removeToBlocklist(1);
+     */
+    async removeFromBlocklist(id, options) {
+        return await this.client.call({ path: `/profile/blocklist/remove/${id}`, ...options });
+    }
 }
 exports.Profile = Profile;

package/dist/api/release.d.ts

@@ -1,5 +1,5 @@
 import { Anixart } from "../client";
-import { ICommentRelease, ICommentReleaseRequest, ICommentReleaseResponse, ICommentRepliesRequest, IDubbersResponse, IRelease, IReleaseResponse, ISourcesResponse, IVideo, IVideoReleaseInCategoryRequest, IVideoResponse, IEpisodesResponse, VoteType, IEpisodeResponse, IBaseApiParams, IBaseCommentAddRequest, IBaseSearchRequest, IPageableResponse, IResponse, IReleaseFilterRequest, IProfileShort, IVideoStreamingPlatform } from "../types";
+import { ICommentRelease, ICommentReleaseRequest, ICommentReleaseResponse, ICommentRepliesRequest, IDubbersResponse, IRelease, IReleaseResponse, ISourcesResponse, IVideo, IVideoReleaseInCategoryRequest, IVideoResponse, IEpisodesResponse, VoteType, IEpisodeResponse, IBaseApiParams, IBaseCommentAddRequest, IPageableResponse, IResponse, IReleaseFilterRequest, IProfileShort, IVideoStreamingPlatform, CommentDeleteResult, CommentEditResult, ILastEpisodeUpdate } from "../types";
 /**
  * Класс релиза
  *
@@ -14,13 +14,12 @@ export declare class Release {
     getComments(data: ICommentReleaseRequest, options?: IBaseApiParams): Promise<IPageableResponse<ICommentRelease>>;
     addComment(id: number, data: IBaseCommentAddRequest, options?: IBaseApiParams): Promise<ICommentReleaseResponse>;
     voteComment(id: number, vote: VoteType, options?: IBaseApiParams): Promise<IResponse>;
-    removeComment(id: number, options?: IBaseApiParams): Promise<IResponse>;
-    editComment(id: number, message: string, spoiler: boolean, options?: IBaseApiParams): Promise<IResponse>;
+    removeComment(id: number, options?: IBaseApiParams): Promise<IResponse<CommentDeleteResult>>;
+    editComment(id: number, message: string, spoiler: boolean, options?: IBaseApiParams): Promise<IResponse<CommentEditResult>>;
     getCommentReplies(data: ICommentRepliesRequest, options?: IBaseApiParams): Promise<IPageableResponse<ICommentRelease>>;
     getRelatedReleases(id: number, page: number, options?: IBaseApiParams): Promise<IPageableResponse<IRelease>>;
     getVideos(id: number, options?: IBaseApiParams): Promise<IVideoResponse>;
     getVideoInCategory(data: IVideoReleaseInCategoryRequest, options?: IBaseApiParams): Promise<IPageableResponse<IVideo>>;
-    search(data: IBaseSearchRequest, options?: IBaseApiParams): Promise<IPageableResponse<IRelease>>;
     getDubbers(id: number, options?: IBaseApiParams): Promise<IDubbersResponse>;
     getDubberSources(id: number, dubberId: number, options?: IBaseApiParams): Promise<ISourcesResponse>;
     getEpisodes(id: number, dubberId: number, sourceId: number, sort?: number, options?: IBaseApiParams): Promise<IEpisodesResponse>;
@@ -38,4 +37,5 @@ export declare class Release {
     removeFromProfileList(id: number, type: number, options?: IBaseApiParams): Promise<IResponse>;
     getStreaming(id: number, options?: IBaseApiParams): Promise<IPageableResponse<IVideoStreamingPlatform>>;
     getCommentVotes(id: number, page: number, options?: IBaseApiParams): Promise<IPageableResponse<IProfileShort>>;
+    getEpisodeUpdates(id: number, page: number, options?: IBaseApiParams): Promise<IPageableResponse<ILastEpisodeUpdate>>;
 }

package/dist/api/release.js

@@ -46,9 +46,6 @@ class Release {
     async getVideoInCategory(data, options) {
         return await this.client.call({ path: `/video/release/${data.id}/category/${data.categoryId}/${data.page}`, ...options });
     }
-    async search(data, options) {
-        return await this.client.call({ path: `/search/releases/${data.page}`, json: { query: data.query, page: data.page }, apiV2: true, ...options });
-    }
     async getDubbers(id, options) {
         return await this.client.call({ path: `/episode/${id}`, ...options });
     }
@@ -100,5 +97,8 @@ class Release {
     async getCommentVotes(id, page, options) {
         return await this.client.call({ path: `/release/comment/votes/${id}/${page}`, ...options });
     }
+    async getEpisodeUpdates(id, page, options) {
+        return await this.client.call({ path: `/episode/updates/${id}/${page}`, ...options });
+    }
 }
 exports.Release = Release;