@up-im/medotvet_sdk 0.0.20 → 0.0.21

package/README.md

@@ -90,12 +90,13 @@ const client = createClient({
 - `getHistory({ page? })` — история прохождений.
 
 ### payment
-- `addSBP({ sum, bank })` — заявка на выплату через СБП, вернёт
-	`iPayment`.
-- `addCard({ sum, card_number })` — заявка на карту, вернёт `iPayment`.
+- `add({ sum })` — заявка на выплату. Реквизиты выплат (карта/СБП/счёт)
+	пользователь указывает сам на странице верификации SolarStaff.
 - `getList({ page?, select })` — список выплат, сортировка `id desc`.
 - `balance()` — баланс и суммы начислений/выплат.
-- `getVerificationUrl()` — ссылка на KYC SolarStaff и признак `verified`.
+- `getVerificationUrl()` — ссылка на KYC-страницу SolarStaff, где
+	пользователь проходит верификацию и добавляет платёжные реквизиты.
+	Возвращает `{ url, verified }`.
 - `checkVerificationStatus()` — статус KYC:
 	`not_started|pending|active|blocked` + текст.
 

package/dist/api/payment.d.ts

@@ -4,22 +4,14 @@ import { iPayment } from "../interfaces/iPayment";
 import { iBalance } from "../interfaces/iBalance";
 export declare class ApiPayment extends ApiAbstract {
     /**
-     * добавление запроса на выплату по системе быстрых платежей
-     * * @param {number} props.sum - сумма выплаты
-     * * @param {number} props.bank - id банка из справочника content.getBanks
+     * Добавление запроса на выплату.
+     * Реквизиты выплаты (карта/СБП/счёт) пользователь добавляет сам
+     * на странице верификации SolarStaff (см. getVerificationUrl) — в этот
+     * запрос они не передаются.
+     * @param {number} props.sum - сумма выплаты
      */
-    addSBP(props: {
+    add(props: {
         sum: number;
-        bank: number;
-    }): Promise<iPayment>;
-    /**
-    * добавление запроса на выплату по номеру карты
-    * * @param {number} props.sum - сумма выплаты
-    * * @param {number} props.card_number - номер карты
-    */
-    addCard(props: {
-        sum: number;
-        card_number: number;
     }): Promise<iPayment>;
     /**
      * список начислений
@@ -36,8 +28,8 @@ export declare class ApiPayment extends ApiAbstract {
      */
     balance(): Promise<iBalance>;
     /**
-     * Получить URL для верификации в SolarStaff
-     * Необходимо для получения выплат
+     * Получить URL страницы верификации в SolarStaff.
+     * На этой же странице пользователь добавляет реквизиты выплат.
      */
     getVerificationUrl(): Promise<{
         url: string;

package/dist/api/payment.js

@@ -3,35 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiPayment = void 0;
 const abstract_1 = require("./abstract");
 const apiRoute_1 = require("../http/apiRoute");
-const payoutType_1 = require("../interfaces/payoutType");
 const apiError_1 = require("../http/apiError");
 class ApiPayment extends abstract_1.ApiAbstract {
     /**
-     * добавление запроса на выплату по системе быстрых платежей
-     * * @param {number} props.sum - сумма выплаты
-     * * @param {number} props.bank - id банка из справочника content.getBanks
+     * Добавление запроса на выплату.
+     * Реквизиты выплаты (карта/СБП/счёт) пользователь добавляет сам
+     * на странице верификации SolarStaff (см. getVerificationUrl) — в этот
+     * запрос они не передаются.
+     * @param {number} props.sum - сумма выплаты
      */
-    async addSBP(props) {
+    async add(props) {
         if (!await this.userStorage.isAuth())
             throw new apiError_1.ApiError(401, "Пользователь не авторизован");
         const data = await this.fetcher({
             route: apiRoute_1.apiRoutePaymentAdd,
-            postBody: { ...props, type: payoutType_1.PayoutType.sbp },
-            options: { addToken: true }
-        });
-        return data.payment;
-    }
-    /**
-    * добавление запроса на выплату по номеру карты
-    * * @param {number} props.sum - сумма выплаты
-    * * @param {number} props.card_number - номер карты
-    */
-    async addCard(props) {
-        if (!await this.userStorage.isAuth())
-            throw new apiError_1.ApiError(401, "Пользователь не авторизован");
-        const data = await this.fetcher({
-            route: apiRoute_1.apiRoutePaymentAdd,
-            postBody: { ...props, type: payoutType_1.PayoutType.card },
+            postBody: props,
             options: { addToken: true }
         });
         return data.payment;
@@ -64,8 +50,8 @@ class ApiPayment extends abstract_1.ApiAbstract {
         });
     }
     /**
-     * Получить URL для верификации в SolarStaff
-     * Необходимо для получения выплат
+     * Получить URL страницы верификации в SolarStaff.
+     * На этой же странице пользователь добавляет реквизиты выплат.
      */
     async getVerificationUrl() {
         if (!await this.userStorage.isAuth())

package/dist/interfaces/iPayment.d.ts

@@ -1,6 +1,5 @@
 import { PaymentStatus, PaymentStatusKeys } from "./paymentStatus";
 import { PaymentType, PaymentTypeKeys } from "./paymentType";
-import { PayoutType, PayoutTypeKeys } from "./payoutType";
 export interface iPayment {
     id: number;
     reg_date: string;
@@ -14,7 +13,6 @@ export interface iPayment {
     shop: number | null;
     cashback_level: 0 | 1 | 2 | 3;
     max_cashback_level: null | 0 | 1 | 2 | 3;
-    payout_type: typeof PayoutType[PayoutTypeKeys] | null;
     last_error: string;
     price: number;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@up-im/medotvet_sdk",
-  "version": "0.0.20",
+  "version": "0.0.21",
   "description": "",
   "main": "dist/index.js",
   "scripts": {

package/src/api/payment.ts

@@ -8,98 +8,85 @@ import {
 } from "../http/apiRoute"
 import { iPagingItems } from "../interfaces/iPagingItems"
 import { iPayment } from "../interfaces/iPayment"
-import { PayoutType } from "../interfaces/payoutType"
 import { ApiError } from "../http/apiError"
 import { iBalance } from "../interfaces/iBalance"
 
 export class ApiPayment extends ApiAbstract {
-    /**
-     * добавление запроса на выплату по системе быстрых платежей
-     * * @param {number} props.sum - сумма выплаты
-     * * @param {number} props.bank - id банка из справочника content.getBanks
-     */
-    async addSBP(props: { sum: number, bank: number }) {
-        if (!await this.userStorage.isAuth()) throw new ApiError(401, "Пользователь не авторизован")
-        const data = await this.fetcher<{ payment: iPayment }>({
-            route: apiRoutePaymentAdd,
-            postBody: { ...props, type: PayoutType.sbp },
-            options: { addToken: true }
-        })
-        return data.payment
-    }
-    /**
-    * добавление запроса на выплату по номеру карты
-    * * @param {number} props.sum - сумма выплаты
-    * * @param {number} props.card_number - номер карты
-    */
-    async addCard(props: { sum: number, card_number: number }) {
-        if (!await this.userStorage.isAuth()) throw new ApiError(401, "Пользователь не авторизован")
-        const data = await this.fetcher<{ payment: iPayment }>({
-            route: apiRoutePaymentAdd,
-            postBody: { ...props, type: PayoutType.card },
-            options: { addToken: true }
-        })
-        return data.payment
-    }
-    /**
-     * список начислений
-     * * @param {number} page - отсчет страниц с первой, чтобы не было путаницы
-     */
-    async getList<Keys extends keyof iPayment>({
-        page = 1,
-        select,
-    }: {
-        page: number
-        select: Keys[],
-    }) {
-        if (!await this.userStorage.isAuth()) throw new ApiError(401, "Пользователь не авторизован")
-        return await this.fetcher<iPagingItems<Pick<iPayment, Keys>>>({
-            route: apiRoutePaymentList({
-                page,
-                sorters: ["id desc"],
-                select
-            }),
-            options: { addToken: true }
-        })
-    }
-    /**
-     * баланс пользователя
-     */
-    async balance() {
-        if (!await this.userStorage.isAuth()) throw new ApiError(401, "Пользователь не авторизован")
-        return await this.fetcher<iBalance>({
-            route: apiRoutePaymentBalance,
-            options: { addToken: true }
-        })
-    }
+	/**
+	 * Добавление запроса на выплату.
+	 * Реквизиты выплаты (карта/СБП/счёт) пользователь добавляет сам
+	 * на странице верификации SolarStaff (см. getVerificationUrl) — в этот
+	 * запрос они не передаются.
+	 * @param {number} props.sum - сумма выплаты
+	 */
+	async add(props: { sum: number }) {
+		if (!await this.userStorage.isAuth()) throw new ApiError(401, "Пользователь не авторизован")
+		const data = await this.fetcher<{ payment: iPayment }>({
+			route: apiRoutePaymentAdd,
+			postBody: props,
+			options: { addToken: true }
+		})
+		return data.payment
+	}
+	/**
+	 * список начислений
+	 * * @param {number} page - отсчет страниц с первой, чтобы не было путаницы
+	 */
+	async getList<Keys extends keyof iPayment>({
+		page = 1,
+		select,
+	}: {
+		page: number
+		select: Keys[],
+	}) {
+		if (!await this.userStorage.isAuth()) throw new ApiError(401, "Пользователь не авторизован")
+		return await this.fetcher<iPagingItems<Pick<iPayment, Keys>>>({
+			route: apiRoutePaymentList({
+				page,
+				sorters: ["id desc"],
+				select
+			}),
+			options: { addToken: true }
+		})
+	}
+	/**
+	 * баланс пользователя
+	 */
+	async balance() {
+		if (!await this.userStorage.isAuth()) throw new ApiError(401, "Пользователь не авторизован")
+		return await this.fetcher<iBalance>({
+			route: apiRoutePaymentBalance,
+			options: { addToken: true }
+		})
+	}
 
-    /**
-     * Получить URL для верификации в SolarStaff
-     * Необходимо для получения выплат
-     */
-    async getVerificationUrl() {
-        if (!await this.userStorage.isAuth()) throw new ApiError(401, "Пользователь не авторизован")
-        return await this.fetcher<{
-            url: string,
-            verified: boolean
-        }>({
-            route: apiRoutePaymentVerificationUrl,
-            options: { addToken: true }
-        })
-    }
+	/**
+	 * Получить URL страницы верификации в SolarStaff.
+	 * На этой же странице пользователь добавляет реквизиты выплат.
+	 */
+	async getVerificationUrl() {
+		if (!await this.userStorage.isAuth()) throw new ApiError(401, "Пользователь не авторизован")
+		return await this.fetcher<{
+			url: string,
+			verified: boolean
+		}>({
+			route: apiRoutePaymentVerificationUrl,
+			options: { addToken: true }
+		})
+	}
 
-    /**
-     * Проверить статус верификации пользователя в SolarStaff
-     */
-    async checkVerificationStatus() {
-        if (!await this.userStorage.isAuth()) throw new ApiError(401, "Пользователь не авторизован")
-        return await this.fetcher<{
-            verified: boolean,
-            status: "not_started" | "pending" | "active" | "blocked",
-            message: string
-        }>({
-            route: apiRoutePaymentVerificationStatus,
-            options: { addToken: true }
-        })
-    }
-}
+	/**
+	 * Проверить статус верификации пользователя в SolarStaff
+	 */
+	async checkVerificationStatus() {
+		if (!await this.userStorage.isAuth()) throw new ApiError(401, "Пользователь не авторизован")
+		return await this.fetcher<{
+			verified: boolean,
+			status: "not_started" | "pending" | "active" | "blocked",
+			message: string
+		}>({
+			route: apiRoutePaymentVerificationStatus,
+			options: { addToken: true }
+		})
+	}
+}

package/src/interfaces/iPayment.ts

@@ -1,6 +1,5 @@
 import { PaymentStatus, PaymentStatusKeys } from "./paymentStatus";
 import { PaymentType, PaymentTypeKeys } from "./paymentType";
-import { PayoutType, PayoutTypeKeys } from "./payoutType";
 
 
 export interface iPayment {
@@ -17,10 +16,9 @@ export interface iPayment {
     sku: number | null//id акции
     shop: number | null//id аптеки
     cashback_level: 0 | 1 | 2 | 3//уровень кэшбека по которому произошло начисление
-    max_cashback_level: null | 0 | 1 | 2 | 3 //макс. возможный уровень кэшбека по акции, поле есть только у начислений в чеках 
+    max_cashback_level: null | 0 | 1 | 2 | 3 //макс. возможный уровень кэшбека по акции, поле есть только у начислений в чеках
 
     //списание
-    payout_type: typeof PayoutType[PayoutTypeKeys] | null //способ выплаты
     last_error: string//текст ошибки выплаты
 
     //размер