node-epicsgg
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • User

Index

Methods

Methods

getCardIds

  • getCardIds(userId: number, collectionId: number): Promise<CardIds[]>

  • Get the cards ids of a given user and a given collection

    Parameters

    • userId: number

      the user id to get its cards ids

    • collectionId: number

      the collection of the cards to get

    Returns Promise<CardIds[]>

getCards

  • getCards(userId: number, cardTemplateId: number): Promise<Card[]>

  • Get the cards of a given user and a given cardTemplate

    Parameters

    • userId: number

      the user id to get its cards

    • cardTemplateId: number

      the cardTemplateId of the cards to get

    Returns Promise<Card[]>

getFunds

  • Get the funds of the currently authenticated user

    Returns Promise<UserFund>

    a Promise resolved with the response or rejected in case of error

getMarketListings

  • getMarketListings(userId: number, page?: number, type?: undefined | string): Promise<UserMarketListings>

  • Get the market listings of a given user id

    Parameters

    • userId: number

      the user id to get its cards

    • Default value page: number = 1

      the page to get (1 page = 40 Market listings)

    • Optional type: undefined | string

      type of item listed (card|pack|sticker)

    Returns Promise<UserMarketListings>

    a Promise resolved with the response or rejected in case of error

getOwned

  • getOwned(userId: number, collectionId: number): Promise<Owned>

  • Get the owned cards and stickers of a given user id and a given collection id

    Parameters

    • userId: number

      the user id to get its cards

    • collectionId: number

      the collection id to get its cards

    Returns Promise<Owned>

    a Promise resolved with the response or rejected in case of error

getPacks

  • Get the owned packs of the currently authenticated user

    Returns Promise<UserPack[]>

    a Promise resolved with the response or rejected in case of error

getShowcasedCards

  • getShowcasedCards(userId: number): Promise<Card[]>

  • Get the showcased cards of a given user id

    Parameters

    • userId: number

      the user id to get its cards

    Returns Promise<Card[]>

    a Promise resolved with the response or rejected in case of error

getStickerIds

  • getStickerIds(userId: number, collectionId: number): Promise<StickerIds[]>

  • Get the stickers ids of a given user and a given collection

    Parameters

    • userId: number

      the user id to get its stickers ids

    • collectionId: number

      the collection of the stickers to get

    Returns Promise<StickerIds[]>

getStickers

  • getStickers(userId: number, stickerTemplateId: number): Promise<Sticker[]>

  • Get the stickers of a given user and a given stickerTemplate

    Parameters

    • userId: number

      the user id to get its stickers

    • stickerTemplateId: number

      the stickerTemplateId of the stickers to get

    Returns Promise<Sticker[]>

getUserSummary

  • getUserSummary(userId: number, season?: number | string): Promise<UserSummary>

openPack

  • openPack(packId: number): Promise<Card[]>

  • Open a given packId from the authenticated user

    Parameters

    • packId: number

      the pack id to open

    Returns Promise<Card[]>

    a Promise resolved with the response or rejected in case of error

redeemCard

  • redeemCard(cardId: number): Promise<void>

  • Redeem a given card

    Parameters

    • cardId: number

      the card id

    Returns Promise<void>

    a Promise resolved with the response or rejected in case of error

searchUsers

  • searchUsers(username: string): Promise<UserData[]>

  • Search players with a given string

    Parameters

    • username: string

      the username to search

    Returns Promise<UserData[]>

    a Promise resolved with the response or rejected in case of error

Legend

  • Constructor
  • Method
  • Property

Generated using TypeDoc