Client | SWGoH.help API client for GAS

SWGoH.help API client class.

Available methods:

client.fetchPlayer(payload: PlayerRequest): PlayerResponse
client.fetchGuild(payload: GuildRequest): GuildResponse
client.fetchUnits(payload: UnitsRequest): UnitsResponse
client.fetchEvents(payload: EventsRequest): EventsResponse
client.fetchBattles(payload: BattlesRequest): BattlesResponse
client.fetchData(payload: DataRequest): DataResponse

Hierarchy

Client

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Client(settings: Settings): Client

- Defined in index.ts:27
Creates a SWGoH.help API client.

Parameters
- settings: Settings
Returns Client

Properties

Private battlesUrl

battlesUrl: string

Private dataUrl

dataUrl: string

Private eventsUrl

eventsUrl: string

Private guildUrl

guildUrl: string

Private playerUrl

playerUrl: string

Private settings

settings: Settings

Private signinUrl

signinUrl: string

Private tokenId

tokenId: string

Private unitsUrl

unitsUrl: string

Methods

Protected fetchAPI

fetchAPI<T>(url: string, payload: any): T

- Defined in index.ts:135
Type parameters
- T
Parameters
- url: string
- payload: any
Returns T

fetchBattles

fetchBattles(payload: BattlesRequest): BattlesResponse

- Defined in index.ts:125
Fetch Battles data

Parameters
- payload: BattlesRequest
Returns BattlesResponse

fetchData

fetchData(payload: DataRequest): AbilityListResponse

- Defined in index.ts:130
Fetch Data data

Parameters
- payload: DataRequest
Returns AbilityListResponse

fetchEvents

fetchEvents(payload: EventsRequest): EventsResponse

- Defined in index.ts:120
Fetch Events data

Parameters
- payload: EventsRequest
Returns EventsResponse

fetchGuild

fetchGuild(payload: GuildRequest): GuildResponse

- Defined in index.ts:106
Fetch Guild data

Parameters
- payload: GuildRequest
Returns GuildResponse

fetchPlayer

fetchPlayer(payload: PlayerRequest): PlayerResponse[]

- Defined in index.ts:97
Fetch Player data

Parameters
- payload: PlayerRequest
Returns PlayerResponse[]

fetchUnits

fetchUnits(payload: UnitsRequest): UnitsResponse

- Defined in index.ts:111
Fetch Units data

Parameters
- payload: UnitsRequest
Returns UnitsResponse

Private getToken

getToken(): string

- Defined in index.ts:176
Retrieve the API session token from Google CacheService. The key is a SHA256 digest of the credentials used to access the API. Caching period is one hour.

If there is no valid API session token, one is created by invoking the login() method.

Returns string

login

login(): string

- Defined in index.ts:64
Attempts to log into the SWGoH.help API.

Returns string

A SWGoH.help API session token

Private setToken

setToken(token: string): void

- Defined in index.ts:188
Store the API session token into Google CacheService. The key is a SHA256 digest of the credentials used to access the API. Caching period is one hour.

Parameters
- token: string
Returns void

Generated using TypeDoc