@companix/yookassa 0.0.3 → 0.0.4

package/dist/api/responses/refund.d.ts

@@ -1,49 +1,197 @@
 import type { CommonAmount, CommonArticles, CommonRefundSettlements, CommonSources } from '../common';
 import { BasicStatusEnum } from '../enums';
+/**
+ * Объект возврата
+ *
+ * Объект возврата (Refund) содержит актуальную информацию о возврате успешного платежа. Он приходит в ответ на любой запрос, связанный с возвратами.
+ *
+ * Объект может содержать параметры и значения, не описанные в этом Справочнике API. Их следует игнорировать.
+ *
+ * Объект возврата (Refund) — актуальная информация о возврате платежа.
+ */
 export interface Refund {
+    /**
+     * Идентификатор возврата платежа в ЮKassa.
+     */
     id: string;
+    /**
+     * Идентификатор платежа в ЮKassa.
+     */
     payment_id: string;
+    /**
+     * Статус возврата платежа. Возможные значения:
+     *
+     * pending — возврат создан, но пока еще обрабатывается;
+     *
+     * succeeded — возврат успешно завершен, указанная в запросе сумма переведена на платежное средство пользователя (финальный и неизменяемый статус);
+     *
+     * canceled — возврат отменен, инициатор и причина отмены указаны в объекте cancellation_details (финальный и неизменяемый статус).
+     */
     status: BasicStatusEnum;
+    /**
+     * Комментарий к статусу canceled: кто отменил возврат и по какой причине.
+     */
     cancellation_details?: RefundCancellationDetails;
+    /**
+     * Статус регистрации чека. Возможные значения:
+     *
+     * pending — данные в обработке;
+     *
+     * succeeded — чек успешно зарегистрирован;
+     *
+     * canceled — чек зарегистрировать не удалось; если используете Чеки от ЮKassa, обратитесь в техническую поддержку, в остальных случаях сформируйте чек вручную.
+     *
+     * Присутствует, если вы используете решения ЮKassa для отправки чеков в налоговую.
+     */
     receipt_registration?: BasicStatusEnum;
+    /**
+     * Время создания возврата. Указывается по UTC и передается в формате ISO 8601, например 2017-11-03T11:52:31.827Z
+     */
     created_at: string;
+    /**
+     * Сумма, возвращенная пользователю.
+     */
     amount: CommonAmount;
+    /**
+     * Основание для возврата денег пользователю.
+     */
     description?: string;
+    /**
+     * Данные о том, с какого магазина и какую сумму нужно удержать для проведения возврата. Присутствует, если вы используете Сплитование платежей.
+     */
     sources?: CommonSources[];
+    /**
+     * Данные о сделке, в составе которой проходит возврат. Присутствует, если вы проводите Безопасную сделку.
+     */
     deal?: RefundDeal;
+    /**
+     * Детали возврата. Зависят от способа оплаты, который использовался при проведении платежа.
+     */
     refund_method?: RefundRefundMethod;
+    /**
+     * Данные об авторизации возврата.
+     *
+     * Присутствуют только для возвратов платежей, совершенных этими способами оплаты: банковская карта, Mir Pay.
+     */
     refund_authorization_details?: RefundRefundAuthorizationDetails;
+    /**
+     * Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.
+     */
     metadata?: Record<string, unknown>;
 }
+/**
+ * Комментарий к статусу canceled: кто отменил возврат и по какой причине.
+ */
 export interface RefundCancellationDetails {
+    /**
+     * Участник процесса возврата, который принял решение отменить транзакцию. Перечень и описание возможных значений
+     */
     party: string;
+    /**
+     * Причина отмены возврата. Перечень и описание возможных значений
+     */
     reason: string;
 }
+/**
+ * Данные о сделке, в составе которой проходит возврат. Присутствует, если вы проводите Безопасную сделку.
+ */
 export interface RefundDeal {
+    /**
+     * Идентификатор сделки. Берется из возвращаемого платежа.
+     */
     id: string;
+    /**
+     * Данные о распределении денег.
+     */
     refund_settlements: CommonRefundSettlements[];
 }
+/**
+ * Данные для возврата платежа через СБП (НСПК).
+ */
 export interface RefundRefundMethodSbp {
+    /**
+     * Код способа оплаты.
+     */
     "type": "sbp";
+    /**
+     * Идентификатор операции в СБП (НСПК). Пример: 1027088AE4CB48CB81287833347A8777.
+     *
+     * Обязательный параметр для возвратов в статусе succeeded. В остальных случаях может отсутствовать.
+     */
     sbp_operation_id?: string;
 }
+/**
+ * Возврат платежа по электронному сертификату.
+ */
 export interface RefundRefundMethodElectronicCertificate {
+    /**
+     * Код способа оплаты.
+     */
     "type": "electronic_certificate";
+    /**
+     * Данные от ФЭС НСПК для возврата на электронный сертификат.
+     */
     electronic_certificate?: RefundRefundMethodElectronicCertificateElectronicCertificate;
+    /**
+     * Корзина возврата — список возвращаемых товаров, для оплаты которых использовался электронный сертификат.
+     *
+     * Присутствует, если оплата была на готовой странице ЮKassa.
+     */
     articles?: CommonArticles[];
 }
+/**
+ * Детали возврата. Зависят от способа оплаты, который использовался при проведении платежа.
+ *
+ * Способы оплаты
+ */
 export type RefundRefundMethod = RefundRefundMethodSbp | RefundRefundMethodElectronicCertificate;
+/**
+ * Данные об авторизации возврата.
+ *
+ * Присутствуют только для возвратов платежей, совершенных этими способами оплаты: банковская карта, Mir Pay.
+ */
 export interface RefundRefundAuthorizationDetails {
+    /**
+     * Retrieval Reference Number — идентификатор банковской транзакции.
+     */
     rrn?: string;
 }
+/**
+ * Данные от ФЭС НСПК для возврата на электронный сертификат.
+ */
 export interface RefundRefundMethodElectronicCertificateElectronicCertificate {
+    /**
+     * Идентификатор корзины возврата, сформированной в НСПК.
+     */
     basket_id: string;
+    /**
+     * Сумма, которая вернется на электронный сертификат.
+     */
     amount: CommonAmount;
 }
+/**
+ * Создание возврата
+ *
+ * В ответ на запрос придет объект возврата в актуальном статусе.
+ */
 export type CreateRefundResponse = Refund;
+/**
+ * Список возвратов
+ *
+ * В ответ на запрос вернется список возвратов с учетом переданных параметров. В списке будет информация о возвратах, созданных за последние 3 года. Список будет отсортирован по времени создания возвратов в порядке убывания.
+ *
+ * Если результатов больше, чем задано в limit, список будет выводиться фрагментами. В этом случае в ответе на запрос вернется фрагмент списка и параметр next_cursor с указателем на следующий фрагмент.
+ *
+ * Подробнее о работе со списками
+ */
 export interface GetRefundsListResponse {
     type: "list";
     items: Refund[];
     next_cursor?: string;
 }
+/**
+ * Информация о возврате
+ *
+ * В ответ на запрос придет объект возврата в актуальном статусе.
+ */
 export type GetRefundResponse = Refund;

package/dist/api/responses/sbp-banks.d.ts

@@ -1,8 +1,33 @@
+/**
+ * Объект участника СБП
+ *
+ * Объект участника СБП (SbpParticipantBank) содержит информацию о банке или платежном сервисе, подключенном к СБП. Возвращается в списке при запросе списка участников СБП.
+ *
+ * Объект может содержать параметры и значения, не описанные в этом Справочнике API. Их следует игнорировать.
+ *
+ * Объект участника СБП (Системы быстрых платежей ЦБ РФ) — актуальная информация о банке или платежном сервисе, подключенном к СБП.
+ */
 export interface SbpBanks {
+    /**
+     * Идентификатор банка или платежного сервиса в СБП (НСПК).
+     */
     bank_id: string;
+    /**
+     * Название банка или платежного сервиса в СБП.
+     */
     name: string;
+    /**
+     * Банковский идентификационный код (БИК) банка или платежного сервиса.
+     */
     bic: string;
 }
+/**
+ * Список участников СБП
+ *
+ * В ответ на запрос вернется список участников СБП. Список будет отсортирован по идентификатору участника в порядке убывания.
+ *
+ * Подробнее о работе со списками
+ */
 export interface GetSbpBanksListResponse {
     type: "list";
     items: SbpBanks[];

package/dist/api/responses/webhook.d.ts

@@ -1,10 +1,38 @@
 import { NotificationEventEnum } from '../enums';
+/**
+ * Объект Webhook
+ *
+ * Объект Webhook содержит информацию о подписке на одно событие.
+ *
+ * Объект может содержать параметры и значения, не описанные в этом Справочнике API. Их следует игнорировать.
+ *
+ * Данные о webhook.
+ */
 export interface Webhook {
+    /**
+     * Идентификатор webhook.
+     */
     id: string;
+    /**
+     * Событие, о котором уведомляет ЮKassa.
+     */
     event: NotificationEventEnum;
+    /**
+     * URL, на который ЮKassa отправляет уведомления.
+     */
     url: string;
 }
+/**
+ * Создание webhook
+ *
+ * В ответ на запрос придет созданный объект webhook.
+ */
 export type CreateWebhookResponse = Webhook;
+/**
+ * Список созданных webhook
+ *
+ * В ответ на запрос придет актуальный список объектов webhook.
+ */
 export interface GetWebhookListResponse {
     type: 'list';
     items: Webhook[];

package/dist/index.js

@@ -14,11 +14,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+// Core exports
 __exportStar(require("./api"), exports);
 __exportStar(require("./yookassa.module"), exports);
 __exportStar(require("./yookassa.service"), exports);
 __exportStar(require("./http/yookassa.error"), exports);
+// Common
 __exportStar(require("./yookassa.interface"), exports);
+// Services and modules
 __exportStar(require("./modules/deal/deal.module"), exports);
 __exportStar(require("./modules/deal/deal.service"), exports);
 __exportStar(require("./modules/invoice/invoice.module"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AACA,wCAAqB;AACrB,oDAAiC;AACjC,qDAAkC;AAClC,wDAAqC;AAGrC,uDAAoC;AAGpC,6DAA0C;AAC1C,8DAA2C;AAC3C,mEAAgD;AAChD,oEAAiD;AACjD,yDAAsC;AACtC,0DAAuC;AACvC,mEAAgD;AAChD,oEAAiD;AACjD,iFAA8D;AAC9D,kFAA+D;AAC/D,iEAA8C;AAC9C,kEAA+C;AAC/C,+EAA4D;AAC5D,gFAA6D;AAC7D,mEAAgD;AAChD,oEAAiD;AACjD,iEAA8C;AAC9C,kEAA+C;AAC/C,uEAAoD;AACpD,wEAAqD;AACrD,oDAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,eAAe;AACf,wCAAqB;AACrB,oDAAiC;AACjC,qDAAkC;AAClC,wDAAqC;AAErC,SAAS;AACT,uDAAoC;AAEpC,uBAAuB;AACvB,6DAA0C;AAC1C,8DAA2C;AAC3C,mEAAgD;AAChD,oEAAiD;AACjD,yDAAsC;AACtC,0DAAuC;AACvC,mEAAgD;AAChD,oEAAiD;AACjD,iFAA8D;AAC9D,kFAA+D;AAC/D,iEAA8C;AAC9C,kEAA+C;AAC/C,+EAA4D;AAC5D,gFAA6D;AAC7D,mEAAgD;AAChD,oEAAiD;AACjD,iEAA8C;AAC9C,kEAA+C;AAC/C,uEAAoD;AACpD,wEAAqD;AACrD,oDAAiC"}

package/dist/modules/deal/deal.service.d.ts

@@ -3,7 +3,23 @@ import type { CreateDealRequest, CreateDealResponse, GetDealResponse, GetDealsLi
 export declare class DealService {
     private readonly http;
     constructor(http: YookassaHttpClient);
+    /**
+     * Создание сделки.
+     *
+     * Запрос позволяет создать сделку, в рамках которой необходимо принять оплату от покупателя и перечислить ее продавцу.
+     */
     create(data: CreateDealRequest): Promise<CreateDealResponse>;
+    /**
+     * Список сделок.
+     *
+     * Запрос позволяет получить список сделок, отфильтрованный по заданным критериям.
+     * Подробнее о работе со списками.
+     */
     getAll(params?: GetDealsListRequest): Promise<GetDealsListResponse>;
+    /**
+     * Информация о сделке.
+     *
+     * Запрос позволяет получить информацию о текущем состоянии сделки по ее уникальному идентификатору.
+     */
     getById(id: string): Promise<GetDealResponse>;
 }

package/dist/modules/deal/deal.service.js

@@ -16,12 +16,28 @@ let DealService = class DealService {
     constructor(http) {
         this.http = http;
     }
+    /**
+     * Создание сделки.
+     *
+     * Запрос позволяет создать сделку, в рамках которой необходимо принять оплату от покупателя и перечислить ее продавцу.
+     */
     async create(data) {
         return this.http.post('/deals', data);
     }
+    /**
+     * Список сделок.
+     *
+     * Запрос позволяет получить список сделок, отфильтрованный по заданным критериям.
+     * Подробнее о работе со списками.
+     */
     async getAll(params = {}) {
         return this.http.get('/deals', params);
     }
+    /**
+     * Информация о сделке.
+     *
+     * Запрос позволяет получить информацию о текущем состоянии сделки по ее уникальному идентификатору.
+     */
     async getById(id) {
         return this.http.get(`/deals/${id}`);
     }

package/dist/modules/deal/deal.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"deal.service.js","sourceRoot":"","sources":["../../../src/modules/deal/deal.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA2C;AAE3C,0EAAoE;AAU7D,IAAM,WAAW,GAAjB,MAAM,WAAW;IACtB,YAAoC,IAAwB;QAAxB,SAAI,GAAJ,IAAI,CAAoB;IAAG,CAAC;IAOzD,KAAK,CAAC,MAAM,CAAC,IAAuB;QACzC,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;IACvC,CAAC;IAQM,KAAK,CAAC,MAAM,CAAC,SAA8B,EAAE;QAClD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IACxC,CAAC;IAOM,KAAK,CAAC,OAAO,CAAC,EAAU;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,CAAC,CAAA;IACtC,CAAC;CACF,CAAA;AA9BY,kCAAW;sBAAX,WAAW;IADvB,IAAA,mBAAU,GAAE;qCAE+B,yCAAkB;GADjD,WAAW,CA8BvB"}
+{"version":3,"file":"deal.service.js","sourceRoot":"","sources":["../../../src/modules/deal/deal.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA2C;AAE3C,0EAAoE;AAU7D,IAAM,WAAW,GAAjB,MAAM,WAAW;IACtB,YAAoC,IAAwB;QAAxB,SAAI,GAAJ,IAAI,CAAoB;IAAG,CAAC;IAEhE;;;;OAIG;IACI,KAAK,CAAC,MAAM,CAAC,IAAuB;QACzC,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;IACvC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,SAA8B,EAAE;QAClD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IACxC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAAC,EAAU;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,CAAC,CAAA;IACtC,CAAC;CACF,CAAA;AA9BY,kCAAW;sBAAX,WAAW;IADvB,IAAA,mBAAU,GAAE;qCAE+B,yCAAkB;GADjD,WAAW,CA8BvB"}

package/dist/modules/invoice/invoice.service.d.ts

@@ -3,6 +3,18 @@ import type { CreateInvoiceRequest, CreateInvoiceResponse, GetInvoiceResponse }
 export declare class InvoiceService {
     private readonly http;
     constructor(http: YookassaHttpClient);
+    /**
+     * Создание счета.
+     *
+     * Используйте этот запрос, чтобы создать в ЮKassa объект счета.
+     * В запросе необходимо передать данные о заказе, которые отобразятся на странице счета,
+     * и данные для проведения платежа.
+     */
     create(data: CreateInvoiceRequest): Promise<CreateInvoiceResponse>;
+    /**
+     * Информация о счете.
+     *
+     * Используйте этот запрос, чтобы получить информацию о текущем состоянии счета по его уникальному идентификатору.
+     */
     getById(id: string): Promise<GetInvoiceResponse>;
 }

package/dist/modules/invoice/invoice.service.js

@@ -16,9 +16,21 @@ let InvoiceService = class InvoiceService {
     constructor(http) {
         this.http = http;
     }
+    /**
+     * Создание счета.
+     *
+     * Используйте этот запрос, чтобы создать в ЮKassa объект счета.
+     * В запросе необходимо передать данные о заказе, которые отобразятся на странице счета,
+     * и данные для проведения платежа.
+     */
     async create(data) {
         return this.http.post('/invoices', data);
     }
+    /**
+     * Информация о счете.
+     *
+     * Используйте этот запрос, чтобы получить информацию о текущем состоянии счета по его уникальному идентификатору.
+     */
     async getById(id) {
         return this.http.get(`/invoices/${id}`);
     }

package/dist/modules/invoice/invoice.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"invoice.service.js","sourceRoot":"","sources":["../../../src/modules/invoice/invoice.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA2C;AAE3C,0EAAoE;AAI7D,IAAM,cAAc,GAApB,MAAM,cAAc;IACzB,YAAoC,IAAwB;QAAxB,SAAI,GAAJ,IAAI,CAAoB;IAAG,CAAC;IASzD,KAAK,CAAC,MAAM,CAAC,IAA0B;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAA;IAC1C,CAAC;IAOM,KAAK,CAAC,OAAO,CAAC,EAAU;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,CAAC,CAAA;IACzC,CAAC;CACF,CAAA;AAtBY,wCAAc;yBAAd,cAAc;IAD1B,IAAA,mBAAU,GAAE;qCAE+B,yCAAkB;GADjD,cAAc,CAsB1B"}
+{"version":3,"file":"invoice.service.js","sourceRoot":"","sources":["../../../src/modules/invoice/invoice.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA2C;AAE3C,0EAAoE;AAI7D,IAAM,cAAc,GAApB,MAAM,cAAc;IACzB,YAAoC,IAAwB;QAAxB,SAAI,GAAJ,IAAI,CAAoB;IAAG,CAAC;IAEhE;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAAC,IAA0B;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAA;IAC1C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAAC,EAAU;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,CAAC,CAAA;IACzC,CAAC;CACF,CAAA;AAtBY,wCAAc;yBAAd,cAAc;IAD1B,IAAA,mBAAU,GAAE;qCAE+B,yCAAkB;GADjD,cAAc,CAsB1B"}

package/dist/modules/me/me.service.d.ts

@@ -3,5 +3,12 @@ import type { GetMeRequest, GetMeResponse } from '../../api';
 export declare class MeService {
     private readonly http;
     constructor(http: YookassaHttpClient);
+    /**
+     * Информация о настройках магазина или шлюза.
+     *
+     * С помощью этого запроса вы можете получить информацию о магазине или шлюзе.
+     * Для Сплитования платежей передайте параметр on_behalf_of с идентификатором магазина продавца.
+     * Для выплат используйте данные для аутентификации шлюза.
+     */
     get(params?: GetMeRequest): Promise<GetMeResponse>;
 }

package/dist/modules/me/me.service.js

@@ -16,6 +16,13 @@ let MeService = class MeService {
     constructor(http) {
         this.http = http;
     }
+    /**
+     * Информация о настройках магазина или шлюза.
+     *
+     * С помощью этого запроса вы можете получить информацию о магазине или шлюзе.
+     * Для Сплитования платежей передайте параметр on_behalf_of с идентификатором магазина продавца.
+     * Для выплат используйте данные для аутентификации шлюза.
+     */
     async get(params = {}) {
         return this.http.get('/me', params);
     }

package/dist/modules/me/me.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"me.service.js","sourceRoot":"","sources":["../../../src/modules/me/me.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA2C;AAE3C,0EAAoE;AAI7D,IAAM,SAAS,GAAf,MAAM,SAAS;IACpB,YAAoC,IAAwB;QAAxB,SAAI,GAAJ,IAAI,CAAoB;IAAG,CAAC;IASzD,KAAK,CAAC,GAAG,CAAC,SAAuB,EAAE;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;IACrC,CAAC;CACF,CAAA;AAbY,8BAAS;oBAAT,SAAS;IADrB,IAAA,mBAAU,GAAE;qCAE+B,yCAAkB;GADjD,SAAS,CAarB"}
+{"version":3,"file":"me.service.js","sourceRoot":"","sources":["../../../src/modules/me/me.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA2C;AAE3C,0EAAoE;AAI7D,IAAM,SAAS,GAAf,MAAM,SAAS;IACpB,YAAoC,IAAwB;QAAxB,SAAI,GAAJ,IAAI,CAAoB;IAAG,CAAC;IAEhE;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CAAC,SAAuB,EAAE;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;IACrC,CAAC;CACF,CAAA;AAbY,8BAAS;oBAAT,SAAS;IADrB,IAAA,mBAAU,GAAE;qCAE+B,yCAAkB;GADjD,SAAS,CAarB"}

package/dist/modules/payment/payment.service.d.ts

@@ -3,9 +3,44 @@ import type { CancelPaymentResponse, CapturePaymentRequest, CapturePaymentRespon
 export declare class PaymentService {
     private readonly http;
     constructor(http: YookassaHttpClient);
+    /**
+     * Создание платежа.
+     *
+     * Чтобы принять оплату, необходимо создать объект платежа — Payment.
+     * Он содержит всю необходимую информацию для проведения оплаты (сумму, валюту и статус).
+     * У платежа линейный жизненный цикл, он последовательно переходит из статуса в статус.
+     */
     create(data: CreatePaymentRequest): Promise<CreatePaymentResponse>;
+    /**
+     * Список платежей.
+     *
+     * Используйте этот запрос, чтобы получить список платежей.
+     * Для выгрузки доступны платежи, созданные за последние 3 года.
+     * Список можно отфильтровать по различным критериям.
+     * Подробнее о работе со списками.
+     */
     getAll(params?: GetPaymentsListRequest): Promise<GetPaymentsListResponse>;
+    /**
+     * Информация о платеже.
+     *
+     * Запрос позволяет получить информацию о текущем состоянии платежа по его уникальному идентификатору.
+     */
     getById(id: string): Promise<GetPaymentResponse>;
+    /**
+     * Подтверждение платежа.
+     *
+     * Подтверждает вашу готовность принять платеж.
+     * После подтверждения платеж перейдет в статус succeeded.
+     * Это значит, что вы можете выдать товар или оказать услугу пользователю.
+     * Подтвердить можно только платеж в статусе waiting_for_capture и только в течение определенного времени.
+     */
     capture(id: string, data?: CapturePaymentRequest): Promise<CapturePaymentResponse>;
+    /**
+     * Отмена платежа.
+     *
+     * Отменяет платеж, находящийся в статусе waiting_for_capture.
+     * Отмена платежа значит, что вы не готовы выдать пользователю товар или оказать услугу.
+     * Как только вы отменяете платеж, ЮKassa начинает возвращать деньги на счет плательщика.
+     */
     cancel(id: string): Promise<CancelPaymentResponse>;
 }

package/dist/modules/payment/payment.service.js

@@ -16,18 +16,53 @@ let PaymentService = class PaymentService {
     constructor(http) {
         this.http = http;
     }
+    /**
+     * Создание платежа.
+     *
+     * Чтобы принять оплату, необходимо создать объект платежа — Payment.
+     * Он содержит всю необходимую информацию для проведения оплаты (сумму, валюту и статус).
+     * У платежа линейный жизненный цикл, он последовательно переходит из статуса в статус.
+     */
     async create(data) {
         return this.http.post('/payments', data);
     }
+    /**
+     * Список платежей.
+     *
+     * Используйте этот запрос, чтобы получить список платежей.
+     * Для выгрузки доступны платежи, созданные за последние 3 года.
+     * Список можно отфильтровать по различным критериям.
+     * Подробнее о работе со списками.
+     */
     async getAll(params = {}) {
         return this.http.get('/payments', params);
     }
+    /**
+     * Информация о платеже.
+     *
+     * Запрос позволяет получить информацию о текущем состоянии платежа по его уникальному идентификатору.
+     */
     async getById(id) {
         return this.http.get(`/payments/${id}`);
     }
+    /**
+     * Подтверждение платежа.
+     *
+     * Подтверждает вашу готовность принять платеж.
+     * После подтверждения платеж перейдет в статус succeeded.
+     * Это значит, что вы можете выдать товар или оказать услугу пользователю.
+     * Подтвердить можно только платеж в статусе waiting_for_capture и только в течение определенного времени.
+     */
     async capture(id, data) {
         return this.http.post(`/payments/${id}/capture`, data);
     }
+    /**
+     * Отмена платежа.
+     *
+     * Отменяет платеж, находящийся в статусе waiting_for_capture.
+     * Отмена платежа значит, что вы не готовы выдать пользователю товар или оказать услугу.
+     * Как только вы отменяете платеж, ЮKassa начинает возвращать деньги на счет плательщика.
+     */
     async cancel(id) {
         return this.http.post(`/payments/${id}/cancel`);
     }

package/dist/modules/payment/payment.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"payment.service.js","sourceRoot":"","sources":["../../../src/modules/payment/payment.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA2C;AAE3C,0EAAoE;AAa7D,IAAM,cAAc,GAApB,MAAM,cAAc;IACzB,YAAoC,IAAwB;QAAxB,SAAI,GAAJ,IAAI,CAAoB;IAAG,CAAC;IASzD,KAAK,CAAC,MAAM,CAAC,IAA0B;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAA;IAC1C,CAAC;IAUM,KAAK,CAAC,MAAM,CAAC,SAAiC,EAAE;QACrD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,CAAA;IAC3C,CAAC;IAOM,KAAK,CAAC,OAAO,CAAC,EAAU;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,CAAC,CAAA;IACzC,CAAC;IAUM,KAAK,CAAC,OAAO,CAAC,EAAU,EAAE,IAA4B;QAC3D,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,UAAU,EAAE,IAAI,CAAC,CAAA;IACxD,CAAC;IASM,KAAK,CAAC,MAAM,CAAC,EAAU;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,CAAA;IACjD,CAAC;CACF,CAAA;AAzDY,wCAAc;yBAAd,cAAc;IAD1B,IAAA,mBAAU,GAAE;qCAE+B,yCAAkB;GADjD,cAAc,CAyD1B"}
+{"version":3,"file":"payment.service.js","sourceRoot":"","sources":["../../../src/modules/payment/payment.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA2C;AAE3C,0EAAoE;AAa7D,IAAM,cAAc,GAApB,MAAM,cAAc;IACzB,YAAoC,IAAwB;QAAxB,SAAI,GAAJ,IAAI,CAAoB;IAAG,CAAC;IAEhE;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAAC,IAA0B;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAA;IAC1C,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,MAAM,CAAC,SAAiC,EAAE;QACrD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,CAAA;IAC3C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAAC,EAAU;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,CAAC,CAAA;IACzC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,OAAO,CAAC,EAAU,EAAE,IAA4B;QAC3D,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,UAAU,EAAE,IAAI,CAAC,CAAA;IACxD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,CAAA;IACjD,CAAC;CACF,CAAA;AAzDY,wCAAc;yBAAd,cAAc;IAD1B,IAAA,mBAAU,GAAE;qCAE+B,yCAAkB;GADjD,cAAc,CAyD1B"}

package/dist/modules/payment-method/payment-method.service.d.ts

@@ -3,6 +3,18 @@ import { YookassaHttpClient } from '../../http/yookassa.http-client';
 export declare class PaymentMethodService {
     private readonly http;
     constructor(http: YookassaHttpClient);
+    /**
+     * Создание способа оплаты.
+     *
+     * Используйте этот запрос, чтобы создать в ЮKassa объект способа оплаты.
+     * В запросе необходимо передать код способа оплаты, который вы хотите сохранить,
+     * и при необходимости дополнительные параметры, связанные с той функциональностью, которую вы хотите использовать.
+     */
     create(data: CreatePaymentMethodRequest): Promise<CreatePaymentMethodResponse>;
+    /**
+     * Информация о способе оплаты.
+     *
+     * Используйте этот запрос, чтобы получить информацию о текущем состоянии способа оплаты по его уникальному идентификатору.
+     */
     getById(id: string): Promise<GetPaymentMethodResponse>;
 }

package/dist/modules/payment-method/payment-method.service.js

@@ -16,9 +16,21 @@ let PaymentMethodService = class PaymentMethodService {
     constructor(http) {
         this.http = http;
     }
+    /**
+     * Создание способа оплаты.
+     *
+     * Используйте этот запрос, чтобы создать в ЮKassa объект способа оплаты.
+     * В запросе необходимо передать код способа оплаты, который вы хотите сохранить,
+     * и при необходимости дополнительные параметры, связанные с той функциональностью, которую вы хотите использовать.
+     */
     async create(data) {
         return this.http.post('/payment_methods', data);
     }
+    /**
+     * Информация о способе оплаты.
+     *
+     * Используйте этот запрос, чтобы получить информацию о текущем состоянии способа оплаты по его уникальному идентификатору.
+     */
     async getById(id) {
         return this.http.get(`/payment_methods/${id}`);
     }

package/dist/modules/payment-method/payment-method.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"payment-method.service.js","sourceRoot":"","sources":["../../../src/modules/payment-method/payment-method.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA2C;AAM3C,0EAAoE;AAG7D,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;IAC/B,YAAoC,IAAwB;QAAxB,SAAI,GAAJ,IAAI,CAAoB;IAAG,CAAC;IASzD,KAAK,CAAC,MAAM,CAAC,IAAgC;QAClD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAA;IACjD,CAAC;IAOM,KAAK,CAAC,OAAO,CAAC,EAAU;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAA;IAChD,CAAC;CACF,CAAA;AAtBY,oDAAoB;+BAApB,oBAAoB;IADhC,IAAA,mBAAU,GAAE;qCAE+B,yCAAkB;GADjD,oBAAoB,CAsBhC"}
+{"version":3,"file":"payment-method.service.js","sourceRoot":"","sources":["../../../src/modules/payment-method/payment-method.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA2C;AAM3C,0EAAoE;AAG7D,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;IAC/B,YAAoC,IAAwB;QAAxB,SAAI,GAAJ,IAAI,CAAoB;IAAG,CAAC;IAEhE;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAAC,IAAgC;QAClD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAA;IACjD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAAC,EAAU;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAA;IAChD,CAAC;CACF,CAAA;AAtBY,oDAAoB;+BAApB,oBAAoB;IADhC,IAAA,mBAAU,GAAE;qCAE+B,yCAAkB;GADjD,oBAAoB,CAsBhC"}

package/dist/modules/payout/payout.service.d.ts

@@ -3,8 +3,34 @@ import type { CreatePayoutRequest, CreatePayoutResponse, GetPayoutResponse, GetP
 export declare class PayoutService {
     private readonly http;
     constructor(http: YookassaHttpClient);
+    /**
+     * Создание выплаты.
+     *
+     * Используйте этот запрос, чтобы создать в ЮKassa объект выплаты.
+     * В запросе необходимо передать сумму выплаты, данные о способе получения выплаты,
+     * описание выплаты и при необходимости дополнительные параметры.
+     */
     create(data: CreatePayoutRequest): Promise<CreatePayoutResponse>;
+    /**
+     * Список выплат.
+     *
+     * Используйте этот запрос, чтобы получить список выплат.
+     * Для выгрузки доступны выплаты, созданные за последние 3 года.
+     * Список можно отфильтровать по различным критериям.
+     */
     getAll(params?: GetPayoutsListRequest): Promise<GetPayoutsListResponse>;
+    /**
+     * Поиск выплат.
+     *
+     * Используйте этот запрос для поиска выплат по заданным критериям.
+     * Доступно только для выплат, созданных за последние 3 месяца.
+     * Сейчас доступен поиск только по параметру metadata.
+     */
     search(params?: GetPayoutsSearchRequest): Promise<GetPayoutsSearchResponse>;
+    /**
+     * Информация о выплате.
+     *
+     * Используйте этот запрос, чтобы получить информацию о текущем состоянии выплаты по ее уникальному идентификатору.
+     */
     getById(id: string): Promise<GetPayoutResponse>;
 }