anixartjs 0.1.0 → 0.1.1

package/dist/api/profile.d.ts

@@ -1,31 +1,388 @@
 import { Anixart } from "../client";
-import { IProfileResponse, IBookmarkRequest, IFriendsRequest, IProfileShort, IFriendRequestResponse, IBaseApiParams, IBaseSearchRequest, IPageableResponse, IRelease, IProfile, IResponse, ISubsciptionCountResponse, IVoteRelease, RemoveFriendRequestResult, AchivementResult, ISocialResponse, IExportBookmarksResponse } from "../types";
+import { IProfileResponse, IBookmarkRequest, IFriendsRequest, IProfileShort, IFriendRequestResponse, IBaseApiParams, IPageableResponse, IRelease, IProfile, IResponse, ISubsciptionCountResponse, IVoteRelease, RemoveFriendRequestResult, AchivementResult, ISocialResponse, IExportBookmarksResponse, BlocklistAddResult, BookmarkType, IChannel } from "../types";
 /**
  * Класс профиля
  *
- * TODO: changeAvatar
+ * TODO: Понять для чего нужен эндпоинт '/profile/process/{id}' - POST
+ * Пока что предположение что это что-то для модерации
  */
 export declare class Profile {
     private readonly client;
     constructor(client: Anixart);
+    /**
+     * Получение информация о профиле по его ID
+     *
+     * Возвращает {@link IProfileResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param id - ID Профиля
+     * @param options - Дополнительные параметры
+     * @returns Информацию о профиле с указанным ID
+     *
+     * @example
+     * const result = await client.endpoints.profile.info(1);
+     */
     info(id: number, options?: IBaseApiParams): Promise<IProfileResponse>;
+    /**
+     * Получение закладок из профиля по его 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                                 //Страница
+     * });
+     */
     getBookmarks(data: IBookmarkRequest, options?: IBaseApiParams): Promise<IPageableResponse<IRelease>>;
-    addBookmark(id: number, type: number, options?: IBaseApiParams): Promise<IResponse>;
-    removeBookmark(id: number, type: number, options?: IBaseApiParams): Promise<IResponse>;
-    search(data: IBaseSearchRequest, options?: IBaseApiParams): Promise<IPageableResponse<IProfile>>;
+    /**
+     * Добавление релиза в закладку
+     *
+     * Возвращает код результата {@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);
+     */
+    addBookmark(id: number, type: BookmarkType, options?: IBaseApiParams): Promise<IResponse>;
+    /**
+     * Удаление релиза из закладки
+     *
+     * Возвращает код результата {@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);
+     */
+    removeBookmark(id: number, type: BookmarkType, options?: IBaseApiParams): Promise<IResponse>;
+    /**
+     * Получение друзей профиля по его 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     //Страница
+     * });
+     */
     getFriends(data: IFriendsRequest, options?: IBaseApiParams): Promise<IPageableResponse<IProfileShort>>;
+    /**
+     * Получение списка рекомендаций для добавления в друзья
+     *
+     * Возвращает список {@link IProfileShort} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param options - Дополнительные параметры
+     * @returns Список потенциальных друзей
+     *
+     * @example
+     * const result = await client.endpoints.profile.getFriendRecomendation();
+     */
     getFriendRecomendation(options?: IBaseApiParams): Promise<IPageableResponse<IProfileShort>>;
-    getFriendRequests(type: "in" | "out", count: number, options?: IBaseApiParams): Promise<IPageableResponse<IProfileShort>>;
+    /**
+     * Получение списка последних заявок в друзья
+     *
+     * Возвращает список {@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);
+     */
+    getLastFriendRequests(type: "in" | "out", count: number, options?: IBaseApiParams): Promise<IPageableResponse<IProfileShort>>;
+    /**
+     * Получение списка заявок в друзья
+     *
+     * Возвращает список {@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);
+     */
+    getFriendRequests(type: "in" | "out", page: number, options?: IBaseApiParams): Promise<IPageableResponse<IProfileShort>>;
+    /**
+     * Отправка запроса на добавление в друзья
+     *
+     * Возвращает ответ {@link IFriendRequestResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}, {@link SendFriendRequestResult}
+     *
+     * @param id - ID Профиля
+     * @param options - Дополнительные параметры
+     * @returns Статус дружбы
+     *
+     * @example
+     * const result = await client.endpoints.profile.sendFriendRequest(1);
+     */
     sendFriendRequest(id: number, options?: IBaseApiParams): Promise<IFriendRequestResponse>;
+    /**
+     * Удаление запроса на добавление в друзья
+     *
+     * Возвращает ответ {@link IFriendRequestResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}, {@link RemoveFriendRequestResult}
+     *
+     * @param id - ID Профиля
+     * @param options - Дополнительные параметры
+     * @returns Статус дружбы
+     *
+     * @example
+     * const result = await client.endpoints.profile.removeFriendRequest(1);
+     */
     removeFriendRequest(id: number, options?: IBaseApiParams): Promise<IFriendRequestResponse<RemoveFriendRequestResult>>;
+    /**
+     * Скрытие запроса на добавление в друзья
+     *
+     * Возвращает ответ {@link IResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param id - ID Профиля
+     * @param options - Дополнительные параметры
+     * @returns Код ответа
+     *
+     * @example
+     * const result = await client.endpoints.profile.hideFriendRequest(1);
+     */
     hideFriendRequest(id: number, options?: IBaseApiParams): Promise<IResponse>;
-    getAchivement(id: number, options?: IBaseApiParams): Promise<IResponse<AchivementResult>>;
-    getFavorites(data: IBookmarkRequest, options?: IBaseApiParams): Promise<IPageableResponse<IRelease>>;
-    getSubsciptions(page: number, options?: IBaseApiParams): Promise<IPageableResponse<any>>;
+    /**
+     * Получение достижения в профиль
+     *
+     * Возвращает ответ {@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);
+     */
+    getAchivement(id: string | number, options?: IBaseApiParams): Promise<IResponse<AchivementResult>>;
+    /**
+     * Получение избранных релизов в профиле
+     *
+     * Возвращает релизы {@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,                      //Фильтр по анонсам
+     * });
+     */
+    getFavorites(data: Omit<IBookmarkRequest, "id" | "type">, options?: IBaseApiParams): Promise<IPageableResponse<IRelease>>;
+    /**
+     * Получение подписок в профиле на каналы и блоги
+     *
+     * Возвращает каналы и блоги {@link IChannel} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param page - Номер страницы
+     * @param options - Дополнительные параметры
+     * @returns Каналы и блоги
+     *
+     * @example
+     * const result = await client.endpoints.profile.getSubsciptions(0);
+     */
+    getSubsciptions(page: number, options?: IBaseApiParams): Promise<IPageableResponse<IChannel>>;
+    /**
+     * Получение количество подписок в профиле на каналы и блоги
+     *
+     * Возвращает число подписок {@link ISubsciptionCountResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param options - Дополнительные параметры
+     * @returns Число подписок
+     *
+     * @example
+     * const result = await client.endpoints.profile.getSubsciptionCount(0);
+     */
     getSubscriptionCount(options?: IBaseApiParams): Promise<ISubsciptionCountResponse>;
+    /**
+     * Получение списка оцененных релизов профиля
+     *
+     * Возвращает список {@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);
+     */
     getVotedReleases(id: number, page: number, sort?: number, options?: IBaseApiParams): Promise<IPageableResponse<IVoteRelease>>;
+    /**
+     * Получение списка юзернеймов профиля на другие соц. сети
+     *
+     * Возвращает ответ {@link ISocialResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param id - ID Профиля
+     * @param options - Дополнительные параметры
+     * @returns Список оцененных релизов
+     *
+     * @example
+     * const result = await client.endpoints.profile.getSocials(1);
+     */
     getSocials(id: number, options?: IBaseApiParams): Promise<ISocialResponse>;
+    /**
+     * Получение списка неоцененных релизов профиля (Предположительно которые находятся в закладках профиля)
+     *
+     * Возвращает список {@link IRelease} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param page - Номер страницы
+     * @param options - Дополнительные параметры
+     * @returns Список неоцененных релизов
+     *
+     * @example
+     * const result = await client.endpoints.profile.getUnvotedReleases(0);
+     */
     getUnvotedReleases(page?: number | "last", options?: IBaseApiParams): Promise<IPageableResponse<IRelease>>;
+    /**
+     * Получение списка профилей у которых есть конкретная роль
+     *
+     * Возвращает список {@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);
+     */
     getRoleProfiles(id: number, page: number, options?: IBaseApiParams): Promise<IPageableResponse<IProfileShort>>;
-    exportBookmarks(listIds: Array<number>, sort?: number, options?: IBaseApiParams): Promise<IExportBookmarksResponse>;
+    /**
+     * Экспорт закладок из профиля
+     *
+     * Возвращает ответ {@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);
+     */
+    exportBookmarks(listIds: Array<BookmarkType>, sort?: number, options?: IBaseApiParams): Promise<IExportBookmarksResponse>;
+    /**
+     * Получение списка профилей которые находятся в блоклисте
+     *
+     * Возвращает список {@link IProfile} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param page - Номер страницы
+     * @param options - Дополнительные параметры
+     * @returns Список профилей
+     *
+     * @example
+     * const result = await client.endpoints.profile.getBlocklist(0);
+     */
+    getBlocklist(page: number, options?: IBaseApiParams): Promise<IPageableResponse<IProfile>>;
+    /**
+     * Добавление профиля в блоклист
+     *
+     * Возвращает ответ {@link IResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param id - ID Профиля
+     * @param options - Дополнительные параметры
+     * @returns Код ответа
+     *
+     * @example
+     * const result = await client.endpoints.profile.addToBlocklist(1);
+     */
+    addToBlocklist(id: number, options?: IBaseApiParams): Promise<IResponse>;
+    /**
+     * Удаление профиля из блоклиста
+     *
+     * Возвращает ответ {@link IResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param id - ID Профиля
+     * @param options - Дополнительные параметры
+     * @returns Код ответа
+     *
+     * @example
+     * const result = await client.endpoints.profile.removeToBlocklist(1);
+     */
+    removeFromBlocklist(id: number, options?: IBaseApiParams): Promise<IResponse<BlocklistAddResult>>;
 }