anixartjs 0.0.9 → 0.1.1

package/dist/api/auth.d.ts

@@ -1,11 +1,102 @@
 import { Anixart } from "../client";
-import { ILoginResponse, ILoginRequest, IRegisterRequest, IRegisterResponse, IRegisterVerifyRequest, IBaseApiParams, IRestorePasswordRequest } from "../types";
+import { ILoginResponse, ILoginRequest, IRegisterRequest, IRegisterResponse, IRegisterVerifyRequest, IBaseApiParams, IRestorePasswordRequest, RegisterVerifyResult, RestorePasswordResult, RestorePasswordVerifyResult } from "../types";
+/**
+ * Класс с эндпоинтами авторизации
+ */
 export declare class Auth {
     private readonly client;
     constructor(client: Anixart);
+    /**
+     * Авторизация в профиль
+     *
+     * Возвращает ответ {@link ILoginResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}, {@link LoginResult}
+     *
+     * @param data - Данные для авторизации
+     * @param options - Дополнительные параметры
+     * @returns Информацию о профиле и токен
+     *
+     * @example
+     * const result = await client.endpoints.auth.signIn({
+     *     login: 'username',   //Логин
+     *     password: 'password' //Пароль
+     * });
+     */
     signIn(data: ILoginRequest, options?: IBaseApiParams): Promise<ILoginResponse>;
+    /**
+     * Регистрация в Anixart
+     *
+     * Возвращает ответ {@link IRegisterResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}, {@link RegisterResult}
+     *
+     * @param data - Данные для регистрации
+     * @param options - Дополнительные параметры
+     * @returns Хеш для подтверждения
+     *
+     * @example
+     * const result = await client.endpoints.auth.signUp({
+     *     username: 'username',    //Логин
+     *     password: 'password',    //Пароль
+     *     email: 'email',          //Почта
+     * });
+     */
     signUp(data: IRegisterRequest, options?: IBaseApiParams): Promise<IRegisterResponse>;
-    signUpVerify(data: IRegisterVerifyRequest, options?: IBaseApiParams): Promise<ILoginResponse>;
-    restore(login: string, options?: IBaseApiParams): Promise<IRegisterResponse>;
-    restoreVerify(data: IRestorePasswordRequest, options?: IBaseApiParams): Promise<ILoginResponse>;
+    /**
+     * Подтверждение регистрации
+     *
+     * Возвращает ответ {@link ILoginResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}, {@link RegisterVerifyResult}
+     *
+     * @param data - Данные для подтверждения
+     * @param options - Дополнительные параметры
+     * @returns Информацию о профиле и токен
+     *
+     * @example
+     * const result = await client.endpoints.auth.signUpVerify({
+     *     username: 'username',    //Логин
+     *     password: 'password',    //Пароль
+     *     email: 'email',          //Почта
+     *     hash: 'hash',            //Хеш
+     *     code: 0000,              //Код
+     * });
+     */
+    signUpVerify(data: IRegisterVerifyRequest, options?: IBaseApiParams): Promise<ILoginResponse<RegisterVerifyResult>>;
+    /**
+     * Восстановление аккаунта по почте
+     *
+     * Возвращает ответ {@link IRegisterResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}, {@link RestorePasswordResult}
+     *
+     * @param login - Логин пользователя
+     * @param options - Дополнительные параметры
+     * @returns Хеш для подтверждения
+     *
+     * @example
+     * const result = await client.endpoints.auth.restore("login");
+     */
+    restore(login: string, options?: IBaseApiParams): Promise<IRegisterResponse<RestorePasswordResult>>;
+    /**
+     * Подтверждение восстановления
+     *
+     * Возвращает ответ {@link ILoginResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}, {@link RestorePasswordVerifyResult}
+     *
+     * @param data - Данные для подтверждения
+     * @param options - Дополнительные параметры
+     * @returns Информацию о профиле и токен
+     *
+     * @example
+     * const result = await client.endpoints.auth.restoreVerify({
+     *     username: 'username',    //Логин
+     *     password: 'password',    //Пароль
+     *     hash: 'hash',            //Хеш
+     *     code: 0000,              //Код
+     * });
+     */
+    restoreVerify(data: IRestorePasswordRequest, options?: IBaseApiParams): Promise<ILoginResponse<RestorePasswordVerifyResult>>;
 }

package/dist/api/auth.js

@@ -1,10 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Auth = void 0;
+/**
+ * Класс с эндпоинтами авторизации
+ */
 class Auth {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * Авторизация в профиль
+     *
+     * Возвращает ответ {@link ILoginResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}, {@link LoginResult}
+     *
+     * @param data - Данные для авторизации
+     * @param options - Дополнительные параметры
+     * @returns Информацию о профиле и токен
+     *
+     * @example
+     * const result = await client.endpoints.auth.signIn({
+     *     login: 'username',   //Логин
+     *     password: 'password' //Пароль
+     * });
+     */
     async signIn(data, options) {
         return this.client.call({
             path: '/auth/signIn',
@@ -12,6 +32,24 @@ class Auth {
             ...options
         });
     }
+    /**
+     * Регистрация в Anixart
+     *
+     * Возвращает ответ {@link IRegisterResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}, {@link RegisterResult}
+     *
+     * @param data - Данные для регистрации
+     * @param options - Дополнительные параметры
+     * @returns Хеш для подтверждения
+     *
+     * @example
+     * const result = await client.endpoints.auth.signUp({
+     *     username: 'username',    //Логин
+     *     password: 'password',    //Пароль
+     *     email: 'email',          //Почта
+     * });
+     */
     async signUp(data, options) {
         return this.client.call({
             path: '/auth/signUp',
@@ -19,6 +57,26 @@ class Auth {
             ...options
         });
     }
+    /**
+     * Подтверждение регистрации
+     *
+     * Возвращает ответ {@link ILoginResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}, {@link RegisterVerifyResult}
+     *
+     * @param data - Данные для подтверждения
+     * @param options - Дополнительные параметры
+     * @returns Информацию о профиле и токен
+     *
+     * @example
+     * const result = await client.endpoints.auth.signUpVerify({
+     *     username: 'username',    //Логин
+     *     password: 'password',    //Пароль
+     *     email: 'email',          //Почта
+     *     hash: 'hash',            //Хеш
+     *     code: 0000,              //Код
+     * });
+     */
     async signUpVerify(data, options) {
         return this.client.call({
             path: '/auth/verify',
@@ -26,6 +84,20 @@ class Auth {
             ...options
         });
     }
+    /**
+     * Восстановление аккаунта по почте
+     *
+     * Возвращает ответ {@link IRegisterResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}, {@link RestorePasswordResult}
+     *
+     * @param login - Логин пользователя
+     * @param options - Дополнительные параметры
+     * @returns Хеш для подтверждения
+     *
+     * @example
+     * const result = await client.endpoints.auth.restore("login");
+     */
     async restore(login, options) {
         return this.client.call({
             path: '/auth/restore',
@@ -33,6 +105,25 @@ class Auth {
             ...options
         });
     }
+    /**
+     * Подтверждение восстановления
+     *
+     * Возвращает ответ {@link ILoginResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}, {@link RestorePasswordVerifyResult}
+     *
+     * @param data - Данные для подтверждения
+     * @param options - Дополнительные параметры
+     * @returns Информацию о профиле и токен
+     *
+     * @example
+     * const result = await client.endpoints.auth.restoreVerify({
+     *     username: 'username',    //Логин
+     *     password: 'password',    //Пароль
+     *     hash: 'hash',            //Хеш
+     *     code: 0000,              //Код
+     * });
+     */
     async restoreVerify(data, options) {
         return this.client.call({
             path: '/auth/restore/verify',

package/dist/api/channel.d.ts

@@ -1,5 +1,5 @@
 import { Anixart } from "../client";
-import { IPageableResponse, IResponse, IBaseApiParams, IChannelResponse, IChannel, IArticle, IChannelSearchRequest, IArticleCreateRequest, IArticleCreateResponse, IChannelCreateRequest, IProfileShort, IArticleCommentResponce, IArticleComment, IBaseCommentAddRequest, IChannelMediaTokenResponse, VoteType, IArticleUploadFileResponse, IUrlResponse, IEmbedData, IArticleResponse, IArticleSuggestionPublishResponse, IArticleSuggestionCreateRequest, IChannelBlockManageRequest, IChannelBlockInfoResponse } from "../types";
+import { IPageableResponse, IResponse, IBaseApiParams, IChannelResponse, IChannel, IArticle, IArticleCreateRequest, IArticleCreateResponse, IChannelCreateRequest, IProfileShort, IArticleCommentResponce, IArticleComment, IBaseCommentAddRequest, IChannelMediaTokenResponse, VoteType, IArticleUploadFileResponse, IUrlResponse, IEmbedData, IArticleResponse, IArticleSuggestionPublishResponse, IArticleSuggestionCreateRequest, IChannelBlockManageRequest, IChannelBlockInfoResponse, ArticleCreateEditResult, ChannelSubscribeResult, ChannelUnsubscribeResult, ChannelCreateEditResult, ArticleDeleteResult, CommentDeleteResult, ChannelBlockResult, ArticleSuggestionDeleteResult, IProfileChannel, BlogCreateResult, ChannelPermissionManageResult, IChannelPermissionManageRequest } from "../types";
 /**
  * Это из беты аниксарта 9.0
  *
@@ -11,19 +11,19 @@ export declare class Channel {
     info(id: number, options?: IBaseApiParams): Promise<IChannelResponse>;
     all(page: number, options?: IBaseApiParams): Promise<IPageableResponse<IChannel>>;
     getBlog(id: number, options?: IBaseApiParams): Promise<IChannelResponse>;
-    subscribe(id: number, options?: IBaseApiParams): Promise<IResponse>;
-    unsubscribe(id: number, options?: IBaseApiParams): Promise<IResponse>;
+    subscribe(id: number, options?: IBaseApiParams): Promise<IResponse<ChannelSubscribeResult>>;
+    unsubscribe(id: number, options?: IBaseApiParams): Promise<IResponse<ChannelUnsubscribeResult>>;
     getArticles(id: number, page: number, date?: number, options?: IBaseApiParams): Promise<IPageableResponse<IArticle>>;
     getArticle(id: number, options?: IBaseApiParams): Promise<IArticleResponse>;
     createArticle(channelId: number, article: IArticleCreateRequest, options?: IBaseApiParams): Promise<IArticleCreateResponse>;
     editArticle(id: number, article: IArticleCreateRequest, options?: IBaseApiParams): Promise<IArticleCreateResponse>;
-    search(data: IChannelSearchRequest, page: number, options?: IBaseApiParams): Promise<IPageableResponse<IChannel>>;
-    create(data: IChannelCreateRequest, options?: IBaseApiParams): Promise<IChannelResponse>;
-    removeArticleComment(id: number, options?: IBaseApiParams): Promise<IResponse>;
-    removeArticle(id: number, options?: IBaseApiParams): Promise<IResponse>;
+    create(data: IChannelCreateRequest, options?: IBaseApiParams): Promise<IChannelResponse<ChannelCreateEditResult>>;
+    createBlog(options?: IBaseApiParams): Promise<IChannelResponse<BlogCreateResult>>;
+    removeArticleComment(id: number, options?: IBaseApiParams): Promise<IResponse<CommentDeleteResult>>;
+    removeArticle(id: number, options?: IBaseApiParams): Promise<IResponse<ArticleDeleteResult>>;
     addArticleComment(id: number, data: IBaseCommentAddRequest, options?: IBaseApiParams): Promise<IArticleCommentResponce>;
     getVotes(id: number, page: number, sort: number, options?: IBaseApiParams): Promise<IPageableResponse<IProfileShort>>;
-    getComments(id: number, page: number, sort: number, options?: IBaseApiParams): Promise<IPageableResponse<IArticleComment>>;
+    getComments(id: number, page: number | "popular", sort: number, options?: IBaseApiParams): Promise<IPageableResponse<IArticleComment>>;
     getCommentReplies(id: number, page: number, sort: number, options?: IBaseApiParams): Promise<IPageableResponse<IArticleComment>>;
     getAvaliableEditor(id: number, isSuggestionMode?: boolean, isEditMode?: boolean, options?: IBaseApiParams): Promise<IChannelMediaTokenResponse>;
     voteArticle(id: number, vote: VoteType, options?: IBaseApiParams): Promise<IResponse>;
@@ -34,9 +34,13 @@ export declare class Channel {
     uploadChannelCover(id: number, file: Buffer, options?: IBaseApiParams): Promise<IUrlResponse>;
     editChannel(id: number, data: IChannelCreateRequest, options?: IBaseApiParams): Promise<IChannelResponse>;
     getArticleSuggestions(id: number, page: number, options?: IBaseApiParams): Promise<IPageableResponse<IArticle>>;
-    removeArticleSuggestion(id: number, options?: IBaseApiParams): Promise<IResponse>;
+    removeArticleSuggestion(id: number, options?: IBaseApiParams): Promise<IResponse<ArticleSuggestionDeleteResult>>;
     publishArticleSuggestion(id: number, options?: IBaseApiParams): Promise<IArticleSuggestionPublishResponse>;
-    createArticleSuggestion(id: number, data: IArticleSuggestionCreateRequest, options?: IBaseApiParams): Promise<IArticleResponse>;
-    manageChannelBlocklist(id: number, data: IChannelBlockManageRequest, options?: IBaseApiParams): Promise<IResponse>;
-    getChannelBlock(id: number, profileId: number, options?: IBaseApiParams): Promise<IChannelBlockInfoResponse>;
+    createArticleSuggestion(id: number, data: IArticleSuggestionCreateRequest, options?: IBaseApiParams): Promise<IArticleResponse<ArticleCreateEditResult>>;
+    manageChannelBlocklist(id: number, data: IChannelBlockManageRequest, options?: IBaseApiParams): Promise<IResponse<ChannelBlockResult>>;
+    getChannelBlockProfile(id: number, profileId: number, options?: IBaseApiParams): Promise<IChannelBlockInfoResponse>;
+    getChannelBlocks(id: number, page: number, options?: IBaseApiParams): Promise<IPageableResponse<IProfileChannel>>;
+    getChannelRecommendations(page: number, options?: IBaseApiParams): Promise<IPageableResponse<IChannel>>;
+    managePermissionChannel(id: number, data: IChannelPermissionManageRequest, options?: IBaseApiParams): Promise<IResponse<ChannelPermissionManageResult>>;
+    getChannelPermissions(id: number, page: number, options?: IBaseApiParams): Promise<IPageableResponse<IProfileChannel>>;
 }

package/dist/api/channel.js

@@ -38,12 +38,12 @@ class Channel {
     async editArticle(id, article, options) {
         return await this.client.call({ path: `/article/edit/${id}`, method: "POST", json: article, ...options });
     }
-    async search(data, page, options) {
-        return await this.client.call({ path: `/search/channels/${page}`, json: data, ...options });
-    }
     async create(data, options) {
         return await this.client.call({ path: `/channel/create`, method: "POST", json: data, ...options });
     }
+    async createBlog(options) {
+        return await this.client.call({ path: `/channel/blog/create`, method: "POST", ...options });
+    }
     async removeArticleComment(id, options) {
         return await this.client.call({ path: `/article/comment/delete/${id}`, ...options });
     }
@@ -104,8 +104,20 @@ class Channel {
     async manageChannelBlocklist(id, data, options) {
         return await this.client.call({ path: `/channel/${id}/block/manage`, json: data, ...options });
     }
-    async getChannelBlock(id, profileId, options) {
+    async getChannelBlockProfile(id, profileId, options) {
         return await this.client.call({ path: `/channel/${id}/block/${profileId}`, ...options });
     }
+    async getChannelBlocks(id, page, options) {
+        return await this.client.call({ path: `/channel/${id}/block/all/${page}`, ...options });
+    }
+    async getChannelRecommendations(page, options) {
+        return await this.client.call({ path: `/channel/recommendation/${page}`, ...options });
+    }
+    async managePermissionChannel(id, data, options) {
+        return await this.client.call({ path: `/channel/${id}/permission/manage`, json: data, ...options });
+    }
+    async getChannelPermissions(id, page, options) {
+        return await this.client.call({ path: `/channel/${id}/permission/all/${page}`, ...options });
+    }
 }
 exports.Channel = Channel;

package/dist/api/collection.d.ts

@@ -1,5 +1,5 @@
 import { Anixart } from "../client";
-import { IPageableResponse, IResponse, IBaseApiParams, ICollectionResponse, IRelease, ICollection, IReleaseInCollectionRequest, ICollectionCreateRequest, ICollectionComment } from "../types";
+import { IPageableResponse, IResponse, IBaseApiParams, ICollectionResponse, IRelease, ICollection, IReleaseInCollectionRequest, ICollectionCreateRequest, ICollectionComment, FavoriteCollectionAddResult, FavoriteCollectionDeleteResult, CollectionCreateEditResult, ReleaseAddCollectionResult, CollectionDeleteResult, IReleaseResponse } from "../types";
 /**
  * Класс коллекции
  *
@@ -12,22 +12,16 @@ export declare class Collection {
     info(id: number, options?: IBaseApiParams): Promise<ICollectionResponse>;
     getCollectionReleases(id: number, page: number, options?: IBaseApiParams): Promise<IPageableResponse<IRelease>>;
     getCollectionFavorites(page: number, options?: IBaseApiParams): Promise<IPageableResponse<ICollection>>;
-    addCollectionFavorite(id: number, options?: IBaseApiParams): Promise<IResponse>;
-    removeCollectionFavorite(id: number, options?: IBaseApiParams): Promise<IResponse>;
+    addCollectionFavorite(id: number, options?: IBaseApiParams): Promise<IResponse<FavoriteCollectionAddResult>>;
+    removeCollectionFavorite(id: number, options?: IBaseApiParams): Promise<IResponse<FavoriteCollectionDeleteResult>>;
     getReleaseInCollection(data: IReleaseInCollectionRequest, options?: IBaseApiParams): Promise<IPageableResponse<ICollection>>;
     getUserCollections(id: number, page: number, options?: IBaseApiParams): Promise<IPageableResponse<ICollection>>;
-    createCollection(data: ICollectionCreateRequest, options?: IBaseApiParams): Promise<ICollectionResponse>;
-    editCollection(id: number, data: ICollectionCreateRequest, options?: IBaseApiParams): Promise<ICollectionResponse>;
-    /**
-     *  {
-          "code": 0,
-          "collection": null
-        }
-     *
-     */
-    addReleaseToCollection(collectionId: number, releaseId: number, options?: IBaseApiParams): Promise<IResponse>;
-    deleteCollection(id: number, options?: IBaseApiParams): Promise<IResponse>;
+    createCollection(data: ICollectionCreateRequest, options?: IBaseApiParams): Promise<ICollectionResponse<CollectionCreateEditResult>>;
+    editCollection(id: number, data: ICollectionCreateRequest, options?: IBaseApiParams): Promise<ICollectionResponse<CollectionCreateEditResult>>;
+    addReleaseToCollection(collectionId: number, releaseId: number, options?: IBaseApiParams): Promise<IResponse<ReleaseAddCollectionResult>>;
+    deleteCollection(id: number, options?: IBaseApiParams): Promise<IResponse<CollectionDeleteResult>>;
     getComments(id: number, page: number, sort: number, options?: IBaseApiParams): Promise<IPageableResponse<ICollectionComment>>;
     getComment(id: number, options?: IBaseApiParams): Promise<IResponse & ICollectionComment>;
     getCommentReplies(id: number, page: number, sort: number, options?: IBaseApiParams): Promise<IPageableResponse<ICollectionComment>>;
+    getRandomRelease(id: number, extended?: boolean, options?: IBaseApiParams): Promise<IReleaseResponse>;
 }

package/dist/api/collection.js

@@ -40,13 +40,6 @@ class Collection {
     async editCollection(id, data, options) {
         return await this.client.call({ path: `/collectionMy/edit/${id}`, json: data, ...options });
     }
-    /**
-     *  {
-          "code": 0,
-          "collection": null
-        }
-     *
-     */
     async addReleaseToCollection(collectionId, releaseId, options) {
         return await this.client.call({ path: `/collectionMy/release/add/${collectionId}`, queryParams: { release_id: releaseId }, ...options });
     }
@@ -62,5 +55,8 @@ class Collection {
     async getCommentReplies(id, page, sort, options) {
         return await this.client.call({ path: `/collection/comment/replies/${id}/${page}`, queryParams: { sort }, method: "POST", ...options });
     }
+    async getRandomRelease(id, extended = true, options) {
+        return await this.client.call({ path: `/release/collection/${id}/random`, queryParams: { extended_mode: extended }, ...options });
+    }
 }
 exports.Collection = Collection;

package/dist/api/discover.d.ts

@@ -3,9 +3,76 @@ import { IPageableResponse, IBaseApiParams, IRelease, ICommentRelease, IInterest
 export declare class Discover {
     private readonly client;
     constructor(client: Anixart);
+    /**
+     * Получение списка релизов которые сейчас смотрят
+     *
+     * Возвращает список {@link IRelease} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param page - Номер страницы
+     * @param options - Дополнительные параметры
+     * @returns Список релизов
+     *
+     * @example
+     * const result = await client.endpoints.discover.getWatching(0);
+     */
     getWatching(page: number, options?: IBaseApiParams): Promise<IPageableResponse<IRelease>>;
+    /**
+     * Получение популяных комментариев (10 штук)
+     *
+     * Возвращает список {@link ICommentRelease} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param options - Дополнительные параметры
+     * @returns Список релизов
+     *
+     * @example
+     * const result = await client.endpoints.discover.getComments();
+     */
     getComments(options?: IBaseApiParams): Promise<IPageableResponse<ICommentRelease>>;
+    /**
+     * Получение самых обсуждаемых релизов (5 штук)
+     *
+     * Возвращает список {@link IRelease} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param options - Дополнительные параметры
+     * @returns Список релизов
+     *
+     * @example
+     * const result = await client.endpoints.discover.getDiscussing();
+     */
     getDiscussing(options?: IBaseApiParams): Promise<IPageableResponse<IRelease>>;
+    /**
+     * Получение списка рекомендаций
+     *
+     * Возвращает список {@link IRelease} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param page - Номер страницы
+     * @param options - Дополнительные параметры
+     * @returns Список релизов
+     *
+     * @example
+     * const result = await client.endpoints.discover.getRecommendations(0);
+     */
     getRecommendations(page: number, options?: IBaseApiParams): Promise<IPageableResponse<IRelease>>;
+    /**
+     * Получение списка интересных релизов
+     *
+     * Возвращает список {@link IInterestingRelease} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param options - Дополнительные параметры
+     * @returns Список релизов
+     *
+     * @example
+     * const result = await client.endpoints.discover.getInteresting(0);
+     */
     getInteresting(options?: IBaseApiParams): Promise<IPageableResponse<IInterestingRelease>>;
 }

package/dist/api/discover.js

@@ -5,18 +5,85 @@ class Discover {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * Получение списка релизов которые сейчас смотрят
+     *
+     * Возвращает список {@link IRelease} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param page - Номер страницы
+     * @param options - Дополнительные параметры
+     * @returns Список релизов
+     *
+     * @example
+     * const result = await client.endpoints.discover.getWatching(0);
+     */
     async getWatching(page, options) {
         return await this.client.call({ path: `/discover/watching/${page}`, ...options });
     }
+    /**
+     * Получение популяных комментариев (10 штук)
+     *
+     * Возвращает список {@link ICommentRelease} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param options - Дополнительные параметры
+     * @returns Список релизов
+     *
+     * @example
+     * const result = await client.endpoints.discover.getComments();
+     */
     async getComments(options) {
         return await this.client.call({ path: `/discover/comments`, ...options });
     }
+    /**
+     * Получение самых обсуждаемых релизов (5 штук)
+     *
+     * Возвращает список {@link IRelease} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param options - Дополнительные параметры
+     * @returns Список релизов
+     *
+     * @example
+     * const result = await client.endpoints.discover.getDiscussing();
+     */
     async getDiscussing(options) {
         return await this.client.call({ path: `/discover/discussing`, ...options });
     }
+    /**
+     * Получение списка рекомендаций
+     *
+     * Возвращает список {@link IRelease} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param page - Номер страницы
+     * @param options - Дополнительные параметры
+     * @returns Список релизов
+     *
+     * @example
+     * const result = await client.endpoints.discover.getRecommendations(0);
+     */
     async getRecommendations(page, options) {
         return await this.client.call({ path: `/discover/recommendations/${page}`, queryParams: { previous_page: page > 0 ? -1 : page - 1 }, ...options });
     }
+    /**
+     * Получение списка интересных релизов
+     *
+     * Возвращает список {@link IInterestingRelease} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param options - Дополнительные параметры
+     * @returns Список релизов
+     *
+     * @example
+     * const result = await client.endpoints.discover.getInteresting(0);
+     */
     async getInteresting(options) {
         return await this.client.call({ path: `/discover/interesting`, ...options });
     }

package/dist/api/feed.d.ts

@@ -3,7 +3,34 @@ import { IPageableResponse, IBaseApiParams, IArticle } from "../types";
 export declare class Feed {
     private readonly client;
     constructor(client: Anixart);
-    news(page: number, options?: IBaseApiParams): Promise<IPageableResponse<IArticle>>;
+    /**
+     * Получение постов с каналов на которые подписан
+     *
+     * Возвращает список {@link IArticle} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param page - Номер страницы
+     * @param options - Дополнительные параметры
+     * @returns Список постов
+     *
+     * @example
+     * const result = await client.endpoints.feed.my(0);
+     */
     my(page: number, options?: IBaseApiParams): Promise<IPageableResponse<IArticle>>;
+    /**
+     * Получение последних выложенных постов
+     *
+     * Возвращает список {@link IArticle} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param page - Номер страницы
+     * @param options - Дополнительные параметры
+     * @returns Список постов
+     *
+     * @example
+     * const result = await client.endpoints.feed.latest(0);
+     */
     latest(page: number, options?: IBaseApiParams): Promise<IPageableResponse<IArticle>>;
 }

package/dist/api/feed.js

@@ -5,12 +5,37 @@ class Feed {
     constructor(client) {
         this.client = client;
     }
-    async news(page, options) {
-        return await this.client.call({ path: `/feed/news/all/${page}`, ...options });
-    }
+    /**
+     * Получение постов с каналов на которые подписан
+     *
+     * Возвращает список {@link IArticle} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param page - Номер страницы
+     * @param options - Дополнительные параметры
+     * @returns Список постов
+     *
+     * @example
+     * const result = await client.endpoints.feed.my(0);
+     */
     async my(page, options) {
         return await this.client.call({ path: `/feed/my/all/${page}`, ...options });
     }
+    /**
+     * Получение последних выложенных постов
+     *
+     * Возвращает список {@link IArticle} внутри {@link IPageableResponse}.
+     *
+     * Возможные ответы API в виде enum смотреть здесь {@link DefaultResult}
+     *
+     * @param page - Номер страницы
+     * @param options - Дополнительные параметры
+     * @returns Список постов
+     *
+     * @example
+     * const result = await client.endpoints.feed.latest(0);
+     */
     async latest(page, options) {
         return await this.client.call({ path: `/article/latest/all/${page}`, method: "POST", ...options });
     }

package/dist/api/index.d.ts

@@ -7,3 +7,4 @@ export * from "./collection";
 export * from "./discover";
 export * from "./channel";
 export * from "./feed";
+export * from "./search";

package/dist/api/index.js

@@ -23,3 +23,4 @@ __exportStar(require("./collection"), exports);
 __exportStar(require("./discover"), exports);
 __exportStar(require("./channel"), exports);
 __exportStar(require("./feed"), exports);
+__exportStar(require("./search"), exports);

package/dist/api/notification.d.ts

@@ -1,5 +1,5 @@
 import { Anixart } from "../client";
-import { IPageableResponse, INotificationCountResponse, IFriendNotification, IRelatedReleaseNotification, IResponse, IBaseApiParams } from "../types";
+import { IPageableResponse, INotificationCountResponse, IFriendNotification, IRelatedReleaseNotification, IResponse, IBaseApiParams, IArticleNotification } from "../types";
 export declare class Notification {
     private readonly client;
     constructor(client: Anixart);
@@ -10,5 +10,7 @@ export declare class Notification {
     getEpisodeNotificaions(page: number, options?: IBaseApiParams): Promise<IPageableResponse<any>>;
     getReleaseCommentNotifications(page: number, options?: IBaseApiParams): Promise<IPageableResponse<any>>;
     getCollectionCommentNotifications(page: number, options?: IBaseApiParams): Promise<IPageableResponse<any>>;
+    getArticleNotifications(page: number, options?: IBaseApiParams): Promise<IPageableResponse<IArticleNotification>>;
     removeAllNotifications(options?: IBaseApiParams): Promise<IResponse>;
+    readNotifications(options?: IBaseApiParams): Promise<IResponse>;
 }