happyoffice-api v1.0.5

Установка

npm install happyoffice-api

Использование

import { HappyOffice } from "happyoffice-api"
const office = new HappyOffice("token")

merchant

merchant.get

Получить информацию о вашем проекте

const result = await office.merchant.get()

interface IMerchatResult {
  ownerVkid: number, 
  diamonds: number, 
  coin: number, 
  name: string, 
  description: string, 
  avatar: string, 
  groupId: number, 
  isAllowed: boolean, 
  webhookUrl: string, 
  id: number
}

merchat.edit

Отредактировать ваш проект

const result = await office.merchant.edit({ ...options })

interface IMerchatResult {
  ownerVkid: number, 
  diamonds: number, 
  coin: number, 
  name: string, 
  description: string, 
  avatar: string, 
  groupId: number, 
  isAllowed: boolean, 
  webhookUrl: string, 
  id: number
}

payment

payment.getHistory

Получить историю платежей

const result = await office.payment.getHistory({ ...options })

interface IPaymentGetHistoryItems {
  id: number, 
  formId: number, 
  toId: number, 
  amount: number, 
  fieId: "coin" | "diamonds", 
  date: string 
}

interface IPaymentGetHistoryResult {
  count: number, 
  items: Array<IPaymentGetHistoryItems> | []
}

payment.getHistoryByIds

Получить информацию о платеже по его ID

const result = await office.payment.getHistoryByIds({ ...options })

interface IPaymentGetHistoryItems {
  id: number, 
  formId: number, 
  toId: number, 
  amount: number, 
  fieId: "coin" | "diamonds", 
  date: string 
}

interface IPaymentGetHistoryResult {
  count: number, 
  items: Array<IPaymentGetHistoryItems> | []
}

payment.send

Совершить перевод другому пользователю

const result = await office.payment.send({ ...options })

interface IPaymentSendResult {
  result: boolean, 
  userId: number
}

users

users.get

Получить информацию о пользователе

const result = await office.users.get({ ...options })

interface IUsersGetItems {
  coin: number, 
  diamonds: number, 
  lvl: number, 
  xp: number, 
  vkid: number, 
  referalVkid: number
}

interface IUsersGetResult {
  count: number, 
  items: Array<IUsersGetItems> | []
}

webhooks

webhooks.create

Установить адрес вебхука, на который будут присылаться уведомления о новых платежах

const result = await office.webhooks.create({ ...options })

interface IWebhooksCreateResult {
  result: boolean, 
  url: string
}

webhooks.get

Получить URL текущего вебхука

const result = await office.webhooks.get()

interface IWebhooksGetResult {
  webhookUrl: string
}

startPollingPayment

Получать входящие платежи

office.webhooks.create({
  url: "http://233.83.3.9", 
  port: 3000
})

office.startPollingPayment(ctx => console.log(ctx))

interface IWebhooksHandlerResult {
  userId: number, 
  fieId: "coin" | "diamonds", 
  amount: number, 
  id: number, 
  sig: string
}

Если нашли ошибку напишите мне