anixartjs 0.1.8 → 1.0.0

package/dist/api/profile/profileList.d.ts

@@ -0,0 +1,135 @@
+import type { IRequestOptions } from "../../core/http/httpTypes";
+import { Anixart } from "../../core/anixartClient";
+import { IPageableResponse, IResponse, BookmarkSortType, BookmarkType, IRelease } from "../../models";
+export declare class ProfileList {
+    private readonly _client;
+    constructor(_client: Anixart);
+    /**
+     * Добавить релиз в выбранный список закладок.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * @param releaseId - ID релиза.
+     * @param status - Список закладок — {@link BookmarkType}.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Ответ API — {@link IResponse}.
+     *
+     * @remarks
+     
+     *
+     * @example
+     * import { Anixart, BookmarkType } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const releaseId = 123;
+     * const status = BookmarkType.Watching;
+     *
+     * const result = await client.endpoints.profileList.add(
+     *   releaseId,
+     *   status,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result.code);
+     */
+    add(releaseId: number, status: BookmarkType, options?: IRequestOptions): Promise<IResponse>;
+    /**
+     * Удалить релиз из выбранного списка закладок.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * @param releaseId - ID релиза.
+     * @param status - Список закладок — {@link BookmarkType}.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Ответ API — {@link IResponse}.
+     *
+     * @remarks
+     
+     *
+     * @example
+     * import { Anixart, BookmarkType } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const releaseId = 123;
+     * const status = BookmarkType.Watching;
+     *
+     * const result = await client.endpoints.profileList.delete(
+     *   releaseId,
+     *   status,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result.code);
+     */
+    delete(releaseId: number, status: BookmarkType, options?: IRequestOptions): Promise<IResponse>;
+    /**
+     * Получить страницу закладок текущего профиля.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * @param status - Список закладок — {@link BookmarkType}.
+     * @param page - Номер страницы, начиная с 0. По умолчанию: 0.
+     * @param sort - Порядок сортировки — {@link BookmarkSortType}. Необязательный параметр.
+     * @param filterAnnounce - Фильтр анонсированных релизов. Необязательный параметр.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Страница результатов — {@link IPageableResponse} с элементами {@link IRelease}.
+     *
+     * @remarks
+     * Необязательные аргументы пропущены через `undefined`, чтобы передать `options` последним.
+     *
+     * @example
+     * import { Anixart, BookmarkType } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const status = BookmarkType.Watching;
+     * const page = 0;
+     *
+     * const result = await client.endpoints.profileList.get(
+     *   status,
+     *   page,
+     *   undefined,
+     *   undefined,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result.content);
+     */
+    get(status: BookmarkType, page?: number, sort?: BookmarkSortType, filterAnnounce?: number, options?: IRequestOptions): Promise<IPageableResponse<IRelease>>;
+    /**
+     * Получить страницу закладок указанного профиля.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * @param profileId - ID профиля.
+     * @param status - Список закладок — {@link BookmarkType}.
+     * @param page - Номер страницы, начиная с 0. По умолчанию: 0.
+     * @param sort - Порядок сортировки — {@link BookmarkSortType}. Необязательный параметр.
+     * @param filterAnnounce - Фильтр анонсированных релизов. Необязательный параметр.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Страница результатов — {@link IPageableResponse} с элементами {@link IRelease}.
+     *
+     * @remarks
+     * Необязательные аргументы пропущены через `undefined`, чтобы передать `options` последним.
+     *
+     * @example
+     * import { Anixart, BookmarkType } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const profileId = 123;
+     * const status = BookmarkType.Watching;
+     * const page = 0;
+     *
+     * const result = await client.endpoints.profileList.getByProfile(
+     *   profileId,
+     *   status,
+     *   page,
+     *   undefined,
+     *   undefined,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result.content);
+     */
+    getByProfile(profileId: number, status: BookmarkType, page?: number, sort?: BookmarkSortType, filterAnnounce?: number, options?: IRequestOptions): Promise<IPageableResponse<IRelease>>;
+}
+//# sourceMappingURL=profileList.d.ts.map

package/dist/api/profile/profileList.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"profileList.d.ts","sourceRoot":"","sources":["../../../src/api/profile/profileList.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,EACL,iBAAiB,EACjB,SAAS,EACT,gBAAgB,EAChB,YAAY,EACZ,QAAQ,EACT,MAAM,cAAc,CAAC;AAEtB,qBAAa,WAAW;IACH,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAAP,OAAO,EAAE,OAAO;IAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACU,GAAG,CACd,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,YAAY,EACpB,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,SAAS,CAAC;IAWrB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACU,MAAM,CACjB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,YAAY,EACpB,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,SAAS,CAAC;IAWrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACU,GAAG,CACd,MAAM,EAAE,YAAY,EACpB,IAAI,GAAE,MAAU,EAChB,IAAI,CAAC,EAAE,gBAAgB,EACvB,cAAc,CAAC,EAAE,MAAM,EACvB,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IAevC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACU,YAAY,CACvB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,YAAY,EACpB,IAAI,GAAE,MAAU,EAChB,IAAI,CAAC,EAAE,gBAAgB,EACvB,cAAc,CAAC,EAAE,MAAM,EACvB,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;CAcxC"}

package/dist/api/profile/profileList.js

@@ -0,0 +1,174 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProfileList = void 0;
+class ProfileList {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    /**
+     * Добавить релиз в выбранный список закладок.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * @param releaseId - ID релиза.
+     * @param status - Список закладок — {@link BookmarkType}.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Ответ API — {@link IResponse}.
+     *
+     * @remarks
+     
+     *
+     * @example
+     * import { Anixart, BookmarkType } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const releaseId = 123;
+     * const status = BookmarkType.Watching;
+     *
+     * const result = await client.endpoints.profileList.add(
+     *   releaseId,
+     *   status,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result.code);
+     */
+    async add(releaseId, status, options = {}) {
+        return (await this._client.http.request({
+            path: `/profile/list/add/${status}/${releaseId}`,
+            method: "GET",
+            auth: { type: "Anixart" },
+            ...options,
+        })).data;
+    }
+    /**
+     * Удалить релиз из выбранного списка закладок.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * @param releaseId - ID релиза.
+     * @param status - Список закладок — {@link BookmarkType}.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Ответ API — {@link IResponse}.
+     *
+     * @remarks
+     
+     *
+     * @example
+     * import { Anixart, BookmarkType } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const releaseId = 123;
+     * const status = BookmarkType.Watching;
+     *
+     * const result = await client.endpoints.profileList.delete(
+     *   releaseId,
+     *   status,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result.code);
+     */
+    async delete(releaseId, status, options = {}) {
+        return (await this._client.http.request({
+            path: `/profile/list/delete/${status}/${releaseId}`,
+            method: "GET",
+            auth: { type: "Anixart" },
+            ...options,
+        })).data;
+    }
+    /**
+     * Получить страницу закладок текущего профиля.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * @param status - Список закладок — {@link BookmarkType}.
+     * @param page - Номер страницы, начиная с 0. По умолчанию: 0.
+     * @param sort - Порядок сортировки — {@link BookmarkSortType}. Необязательный параметр.
+     * @param filterAnnounce - Фильтр анонсированных релизов. Необязательный параметр.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Страница результатов — {@link IPageableResponse} с элементами {@link IRelease}.
+     *
+     * @remarks
+     * Необязательные аргументы пропущены через `undefined`, чтобы передать `options` последним.
+     *
+     * @example
+     * import { Anixart, BookmarkType } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const status = BookmarkType.Watching;
+     * const page = 0;
+     *
+     * const result = await client.endpoints.profileList.get(
+     *   status,
+     *   page,
+     *   undefined,
+     *   undefined,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result.content);
+     */
+    async get(status, page = 0, sort, filterAnnounce, options = {}) {
+        return (await this._client.http.request({
+            path: `/profile/list/all/${status}/${page}`,
+            method: "GET",
+            auth: { type: "Anixart" },
+            query: {
+                sort,
+                filter_announce: filterAnnounce,
+            },
+            ...options,
+        })).data;
+    }
+    /**
+     * Получить страницу закладок указанного профиля.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * @param profileId - ID профиля.
+     * @param status - Список закладок — {@link BookmarkType}.
+     * @param page - Номер страницы, начиная с 0. По умолчанию: 0.
+     * @param sort - Порядок сортировки — {@link BookmarkSortType}. Необязательный параметр.
+     * @param filterAnnounce - Фильтр анонсированных релизов. Необязательный параметр.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Страница результатов — {@link IPageableResponse} с элементами {@link IRelease}.
+     *
+     * @remarks
+     * Необязательные аргументы пропущены через `undefined`, чтобы передать `options` последним.
+     *
+     * @example
+     * import { Anixart, BookmarkType } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const profileId = 123;
+     * const status = BookmarkType.Watching;
+     * const page = 0;
+     *
+     * const result = await client.endpoints.profileList.getByProfile(
+     *   profileId,
+     *   status,
+     *   page,
+     *   undefined,
+     *   undefined,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result.content);
+     */
+    async getByProfile(profileId, status, page = 0, sort, filterAnnounce, options = {}) {
+        return (await this._client.http.request({
+            path: `/profile/list/all/${profileId}/${status}/${page}`,
+            method: "GET",
+            auth: { type: "Anixart" },
+            query: {
+                sort,
+                filter_announce: filterAnnounce,
+            },
+            ...options,
+        })).data;
+    }
+}
+exports.ProfileList = ProfileList;
+//# sourceMappingURL=profileList.js.map

package/dist/api/profile/profileList.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"profileList.js","sourceRoot":"","sources":["../../../src/api/profile/profileList.ts"],"names":[],"mappings":";;;AAWA,MAAa,WAAW;IACc;IAApC,YAAoC,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;IAAG,CAAC;IAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACI,KAAK,CAAC,GAAG,CACd,SAAiB,EACjB,MAAoB,EACpB,UAA2B,EAAE;QAE7B,OAAO,CACL,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAY;YACzC,IAAI,EAAE,qBAAqB,MAAM,IAAI,SAAS,EAAE;YAChD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;YACzB,GAAG,OAAO;SACX,CAAC,CACH,CAAC,IAAI,CAAC;IACT,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACI,KAAK,CAAC,MAAM,CACjB,SAAiB,EACjB,MAAoB,EACpB,UAA2B,EAAE;QAE7B,OAAO,CACL,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAY;YACzC,IAAI,EAAE,wBAAwB,MAAM,IAAI,SAAS,EAAE;YACnD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;YACzB,GAAG,OAAO;SACX,CAAC,CACH,CAAC,IAAI,CAAC;IACT,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACI,KAAK,CAAC,GAAG,CACd,MAAoB,EACpB,OAAe,CAAC,EAChB,IAAuB,EACvB,cAAuB,EACvB,UAA2B,EAAE;QAE7B,OAAO,CACL,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAA8B;YAC3D,IAAI,EAAE,qBAAqB,MAAM,IAAI,IAAI,EAAE;YAC3C,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;YACzB,KAAK,EAAE;gBACL,IAAI;gBACJ,eAAe,EAAE,cAAc;aAChC;YACD,GAAG,OAAO;SACX,CAAC,CACH,CAAC,IAAI,CAAC;IACT,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACI,KAAK,CAAC,YAAY,CACvB,SAAiB,EACjB,MAAoB,EACpB,OAAe,CAAC,EAChB,IAAuB,EACvB,cAAuB,EACvB,UAA2B,EAAE;QAE7B,OAAO,CACL,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAA8B;YAC3D,IAAI,EAAE,qBAAqB,SAAS,IAAI,MAAM,IAAI,IAAI,EAAE;YACxD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;YACzB,KAAK,EAAE;gBACL,IAAI;gBACJ,eAAe,EAAE,cAAc;aAChC;YACD,GAAG,OAAO;SACX,CAAC,CACH,CAAC,IAAI,CAAC;IACT,CAAC;CACF;AAtMD,kCAsMC"}