anixartjs 0.1.7 → 1.0.0

package/dist/api/report.d.ts

@@ -0,0 +1,68 @@
+import type { IRequestOptions } from "../core/http/httpTypes";
+import { Anixart } from "../core/anixartClient";
+import { IReportReason, IReportRequest, IResponse, IReportPayloadMap, ReportResult, ReportType } from "../models";
+export declare class Report {
+    private readonly _client;
+    constructor(_client: Anixart);
+    /**
+     * Получить допустимые причины жалобы для выбранного типа объекта.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * @param type - Тип объекта жалобы — {@link ReportType}.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Список результатов — {@link IReportReason}[].
+     *
+     * @example
+     * import { Anixart, ReportType } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const type = ReportType.Article;
+     *
+     * const result = await client.endpoints.report.reasons(
+     *   type,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result);
+     */
+    reasons(type: ReportType, options?: IRequestOptions): Promise<IReportReason[]>;
+    /**
+     * Отправить жалобу на объект выбранного типа.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * Коды результата: {@link CommonResult}, {@link ReportResult}.
+     *
+     * @param type - Тип объекта жалобы — {@link ReportType}.
+     * @param data - Данные запроса — {@link IReportRequest}.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Ответ API — {@link IResponse} с кодами {@link ReportResult}.
+     *
+     * @remarks
+     
+     * Получите допустимый reason через report.reasons(type). Для ReportType.Episode передаётся объект серии, для остальных типов — ID.
+     *
+     * @example
+     * import { Anixart, ReportType } from "anixartjs";
+     * import type { IReportRequest } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const type = ReportType.Release;
+     * const report: IReportRequest = {
+     *   entity_id: 123,
+     *   message: "Описание обнаруженной проблемы",
+     *   reason: 1,
+     * };
+     *
+     * const result = await client.endpoints.report.send(
+     *   type,
+     *   report,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result.code);
+     */
+    send<T extends ReportType>(type: T, data: IReportRequest<IReportPayloadMap[T]>, options?: IRequestOptions): Promise<IResponse<ReportResult>>;
+}
+//# sourceMappingURL=report.d.ts.map

package/dist/api/report.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"report.d.ts","sourceRoot":"","sources":["../../src/api/report.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EACL,aAAa,EACb,cAAc,EACd,SAAS,EACT,iBAAiB,EACjB,YAAY,EACZ,UAAU,EACX,MAAM,WAAW,CAAC;AAEnB,qBAAa,MAAM;IACE,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAAP,OAAO,EAAE,OAAO;IAEpD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,OAAO,CAClB,IAAI,EAAE,UAAU,EAChB,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,aAAa,EAAE,CAAC;IAW3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACU,IAAI,CAAC,CAAC,SAAS,UAAU,EACpC,IAAI,EAAE,CAAC,EACP,IAAI,EAAE,cAAc,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,EAC1C,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;CAepC"}

package/dist/api/report.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Report = void 0;
+const models_1 = require("../models");
+class Report {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    /**
+     * Получить допустимые причины жалобы для выбранного типа объекта.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * @param type - Тип объекта жалобы — {@link ReportType}.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Список результатов — {@link IReportReason}[].
+     *
+     * @example
+     * import { Anixart, ReportType } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const type = ReportType.Article;
+     *
+     * const result = await client.endpoints.report.reasons(
+     *   type,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result);
+     */
+    async reasons(type, options = {}) {
+        return (await this._client.http.request({
+            path: `/report/${type}/reasons`,
+            method: "GET",
+            auth: { type: "Anixart" },
+            ...options,
+        })).data;
+    }
+    /**
+     * Отправить жалобу на объект выбранного типа.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * Коды результата: {@link CommonResult}, {@link ReportResult}.
+     *
+     * @param type - Тип объекта жалобы — {@link ReportType}.
+     * @param data - Данные запроса — {@link IReportRequest}.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Ответ API — {@link IResponse} с кодами {@link ReportResult}.
+     *
+     * @remarks
+     
+     * Получите допустимый reason через report.reasons(type). Для ReportType.Episode передаётся объект серии, для остальных типов — ID.
+     *
+     * @example
+     * import { Anixart, ReportType } from "anixartjs";
+     * import type { IReportRequest } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const type = ReportType.Release;
+     * const report: IReportRequest = {
+     *   entity_id: 123,
+     *   message: "Описание обнаруженной проблемы",
+     *   reason: 1,
+     * };
+     *
+     * const result = await client.endpoints.report.send(
+     *   type,
+     *   report,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result.code);
+     */
+    async send(type, data, options = {}) {
+        return (await this._client.http.request({
+            path: `/report/${type}`,
+            method: "POST",
+            body: {
+                type: "JSON",
+                data,
+            },
+            auth: { type: "Anixart" },
+            resultEnum: models_1.ReportResult,
+            ...options,
+        })).data;
+    }
+}
+exports.Report = Report;
+//# sourceMappingURL=report.js.map

package/dist/api/report.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"report.js","sourceRoot":"","sources":["../../src/api/report.ts"],"names":[],"mappings":";;;AAGA,sCAOmB;AAEnB,MAAa,MAAM;IACmB;IAApC,YAAoC,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;IAAG,CAAC;IAExD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,KAAK,CAAC,OAAO,CAClB,IAAgB,EAChB,UAA2B,EAAE;QAE7B,OAAO,CACL,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAkB;YAC/C,IAAI,EAAE,WAAW,IAAI,UAAU;YAC/B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;YACzB,GAAG,OAAO;SACX,CAAC,CACH,CAAC,IAAI,CAAC;IACT,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACI,KAAK,CAAC,IAAI,CACf,IAAO,EACP,IAA0C,EAC1C,UAA2B,EAAE;QAE7B,OAAO,CACL,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAA0B;YACvD,IAAI,EAAE,WAAW,IAAI,EAAE;YACvB,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,IAAI,EAAE,MAAM;gBACZ,IAAI;aACL;YACD,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;YACzB,UAAU,EAAE,qBAAY;YACxB,GAAG,OAAO;SACX,CAAC,CACH,CAAC,IAAI,CAAC;IACT,CAAC;CACF;AA9FD,wBA8FC"}