Module @foxogram/api-types

Foxogram API Types

Simple type definitions for the Foxogram API.

Install with npm / yarn / pnpm:

npm install @foxogram/api-types
yarn add @foxogram/api-types
pnpm add @foxogram/api-types
import { APIChannel } from "@foxogram/api-types";

Enumerations

ChannelType
ExceptionCodes
MemberPermissions
UserFlags
UserType

Interfaces

APIChannel
APIException
APIMember
APIMessage
APIOk
APIToken
APIUser
RESTDeleteAPIUserBody
RESTGetAPIMessageListQuery
RESTPatchAPIChannelBody
RESTPatchAPIMessageBody
RESTPatchAPIUserBody
RESTPostAPIAuthLoginBody
RESTPostAPIAuthRegisterBody
RESTPostAPIAuthResetPasswordBody
RESTPostAPIAuthResetPasswordConfirmBody
RESTPostAPIAuthVerifyEmailBody
RESTPostAPIChannelBody
RESTPostAPIMessageBody
RESTPostAPIUserDeleteConfirmBody

Type Aliases

MemberKey
RESTDeleteAPIChannelLeaveResult
RESTDeleteAPIChannelResult
RESTDeleteAPIMessageResult
RESTDeleteAPIUserResult
RESTGetAPIChannelMemberResult
RESTGetAPIChannelMembersResult
RESTGetAPIChannelResult
RESTGetAPIMessageListResult
RESTGetAPIMessageResult
RESTGetAPIUserChannelsResult
RESTGetAPIUserResult
RESTPatchAPIChannelResult
RESTPatchAPIMessageResult
RESTPatchAPIUserResult
RESTPostAPIAuthLoginResult
RESTPostAPIAuthRegisterResult
RESTPostAPIAuthResendEmailResult
RESTPostAPIAuthResetPasswordConfirmResult
RESTPostAPIAuthResetPasswordResult
RESTPostAPIAuthVerifyEmailResult
RESTPostAPIChannelResult
RESTPostAPIMessageResult
RESTPostAPIUserDeleteConfirmResult
RESTPutAPIChannelJoinResult
UserKey

Variables

APIRoutes
RouteBases
UserMe