-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: update Character schema to follow api updates
- Loading branch information
Showing
1 changed file
with
16 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,20 @@ | ||
import { Character } from './character'; | ||
|
||
export interface CharacterResponse { | ||
Payload: Character; | ||
/** | ||
* State | Number | Details | ||
* --- | --- | --- | ||
* STATE_ADDING | 1 | This state is returned when the character does not exist on the API | ||
* and needs adding (the first ever request and sub-sequent requests until the character is added). | ||
* The Payload should be empty if this state is provided. | ||
* You are advised to inform your audience that a character add request has been performed. | ||
* It should take 2 minutes or less to add your character. | ||
* | ||
* STATE_CACHED | 2 | This state is returned when the character exists in the system and you're being provided a cached response. | ||
* The Payload will contain the character information which will include useful information such as LastUpdated | ||
* which you can use to base on if a character update request is required | ||
* STATE_NOT_FOUND | 3 | This state is returned when a character does not exist on The Lodestone. | ||
* If a character is attempted to be added but the system does not find it then it will be registered as not found. | ||
* The Payload will return empty. Characters in this state are checked every 24 hours, | ||
* if the character continues to not be found after several tries then this entry will be deleted. | ||
* You can also request a deletion of this entry via the /Delete endpoint. | ||
*/ | ||
State: 1 | 2 | 3; | ||
// TODO | ||
Achievements: any; | ||
|
||
Character: Character; | ||
|
||
// TODO | ||
FreeCompany: any; | ||
|
||
// TODO | ||
FreeCompanyMembers: any; | ||
|
||
// TODO | ||
Info: any; | ||
|
||
// TODO | ||
PvPTeam: any; | ||
} |