FoxoChat.js Packages
    Preparing search index...

    Module @foxochat/api-types

    FoxoChat API Types

    Simple type definitions for the FoxoChat API.

    Install with npm / yarn / pnpm:

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

    Enumerations

    AttachmentFlags
    ChannelFlags
    ChannelType
    ExceptionCodes
    MemberPermissions
    UserFlags
    UserStatus
    UserType

    Interfaces

    APIAttachment
    APIAvatar
    APIChannel
    APIException
    APIInfo
    APIMediaUpload
    APIMember
    APIMessage
    APIOk
    APIToken
    APIUser
    RESTAPIAttachmentUploadRequest
    RESTAPIAvatarUploadRequest
    RESTDeleteAPIUserBody
    RESTGetAPIMessageListQuery
    RESTPatchAPIChannelBody
    RESTPatchAPIMessageBody
    RESTPatchAPIUserBody
    RESTPostAPIAuthLoginBody
    RESTPostAPIAuthRegisterBody
    RESTPostAPIAuthResetPasswordBody
    RESTPostAPIAuthResetPasswordConfirmBody
    RESTPostAPIAuthVerifyEmailBody
    RESTPostAPIChannelBody
    RESTPostAPIMessageBody
    RESTPostAPIUserDeleteConfirmBody
    RouteUrls

    Type Aliases

    Id
    MemberKey
    PublicChannelKey
    PublicKey
    PublicUserKey
    RESTAPIAttachmentUploadResponse
    RESTAPIAvatarUploadResponse
    RESTDeleteAPIChannelLeaveResult
    RESTDeleteAPIChannelResult
    RESTDeleteAPIMessageResult
    RESTDeleteAPIUserContactResult
    RESTDeleteAPIUserResult
    RESTGetAPIChannelMemberResult
    RESTGetAPIChannelMembersResult
    RESTGetAPIChannelResult
    RESTGetAPIInfoResult
    RESTGetAPIMessageListResult
    RESTGetAPIMessageResult
    RESTGetAPIUserChannelsResult
    RESTGetAPIUserContactsResult
    RESTGetAPIUserResult
    RESTPatchAPIChannelResult
    RESTPatchAPIMessageResult
    RESTPatchAPIUserResult
    RESTPostAPIAuthLoginResult
    RESTPostAPIAuthRegisterResult
    RESTPostAPIAuthResendEmailResult
    RESTPostAPIAuthResetPasswordConfirmResult
    RESTPostAPIAuthResetPasswordResult
    RESTPostAPIAuthVerifyEmailResult
    RESTPostAPIChannelCreateDMBody
    RESTPostAPIChannelCreateDMResult
    RESTPostAPIChannelResult
    RESTPostAPIMessageResult
    RESTPostAPIUserContactResult
    RESTPostAPIUserDeleteConfirmResult
    RESTPutAPIChannelIconBody
    RESTPutAPIChannelIconResult
    RESTPutAPIChannelJoinResult
    RESTPutAPIMessageAttachmentsBody
    RESTPutAPIMessageAttachmentsResult
    RESTPutAPIUserAvatarBody
    RESTPutAPIUserAvatarResult
    RESTPutAPIUserBannerBody
    RESTPutAPIUserBannerResult
    RouteEnvironment
    Timestamp

    Variables

    APIRoutes
    MediaRoutes
    RouteUrlsMap
    UserMe