Skip to content

Commit 13acf73

Browse files
committed
fix: update Character schema to follow api updates
1 parent c76c886 commit 13acf73

File tree

1 file changed

+16
-20
lines changed

1 file changed

+16
-20
lines changed
Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,20 @@
11
import { Character } from './character';
22

33
export interface CharacterResponse {
4-
Payload: Character;
5-
/**
6-
* State | Number | Details
7-
* --- | --- | ---
8-
* STATE_ADDING | 1 | This state is returned when the character does not exist on the API
9-
* and needs adding (the first ever request and sub-sequent requests until the character is added).
10-
* The Payload should be empty if this state is provided.
11-
* You are advised to inform your audience that a character add request has been performed.
12-
* It should take 2 minutes or less to add your character.
13-
*
14-
* STATE_CACHED | 2 | This state is returned when the character exists in the system and you're being provided a cached response.
15-
* The Payload will contain the character information which will include useful information such as LastUpdated
16-
* which you can use to base on if a character update request is required
17-
* STATE_NOT_FOUND | 3 | This state is returned when a character does not exist on The Lodestone.
18-
* If a character is attempted to be added but the system does not find it then it will be registered as not found.
19-
* The Payload will return empty. Characters in this state are checked every 24 hours,
20-
* if the character continues to not be found after several tries then this entry will be deleted.
21-
* You can also request a deletion of this entry via the /Delete endpoint.
22-
*/
23-
State: 1 | 2 | 3;
4+
// TODO
5+
Achievements: any;
6+
7+
Character: Character;
8+
9+
// TODO
10+
FreeCompany: any;
11+
12+
// TODO
13+
FreeCompanyMembers: any;
14+
15+
// TODO
16+
Info: any;
17+
18+
// TODO
19+
PvPTeam: any;
2420
}

0 commit comments

Comments
 (0)