spookvooper-api/src/modules/interfaces/Interfaces.ts

// SpookVooper API - modules/interfaces/Interfaces.ts
// Written by Quinn Lane - https://quinnlane.dev/

import { CreditAmount, DistrictWealthType, PaymentEntity, SenatorDistrict } from '../types/Types'

interface EntityUser {
  svid: string
  apikey: string
  getUser: () => Promise<any>
  getUsername: () => Promise<any>
  getBalance: () => Promise<any>
  hasDiscordRole: (role: string) => Promise<any>
  getDiscordRoles: () => Promise<any>
  sendCredits: (amount: CreditAmount, to: PaymentEntity, reason: string) => Promise<any>
  getStockOffers: (ticker: string) => Promise<any>
  buyStock: (ticker: string, amount: number, price: CreditAmount) => Promise<any>
  sellStock: (ticker: string, amount: number, price: CreditAmount) => Promise<any>
}

interface EntityGroup {
  svid: string
}

interface EntityDistrict {
  name: string
  getWealth: (type: DistrictWealthType) => Promise<number>
  getSenator: (district: SenatorDistrict) => Promise<ReturnedUser>
}

/*
    Class Constructor Configuration
*/

interface ConfigUser {
  svid: string
  apikey?: string
}

interface ConfigAuth {
  clientid: string
  clientsecret: string
}

/*
    Returned values from SVAPI
*/

interface ReturnedUser {
  userName: string
  twitch_id: string | null
  discord_id: number | null
  post_likes: number
  comment_likes: number
  nationstate: string | null
  description: string | null
  api_use_count: number
  minecraft_id: string | null
  twitch_last_message_minute: number
  twitch_message_xp: number
  twitch_messages: number
  discord_commends: number
  discord_commends_sent: number
  discord_last_commend_hour: number
  discord_last_commend_message: number
  discord_message_xp: number
  discord_message_count: number
  discord_last_message_minute: number
  discord_warning_count: number
  discord_ban_count: number
  discord_kick_count: number
  discord_game_xp: number
  district: string | null
  id: string
  name: string
  credits: number
  image_Url: string | null
}

interface ReturnedTransaction {
  FromAccount: string
  ToAccount: string
  Amount: number
  Detail: string
  Force: boolean
  IsCompleted: boolean
  Tax: number
  Result: {
    Info: string
    Succeeded: boolean
  }
}

export {
  // API Entities
  EntityUser,
  EntityGroup,
  EntityDistrict,
  // Class Config Interfaces
  ConfigUser,
  ConfigAuth,
  // API Return Values
  ReturnedUser,
  ReturnedTransaction
}