feat: support for /Character endpoint

Author: Supamiu

src/model/index.ts

@@ -8,3 +8,4 @@ export { XivapiOptions } from './xivapi-options';
 export { XivapiRequestOptions } from './xivapi-request-options';
 export { XivapiSearchFilter } from './xivapi-search-filter';
 export { XivapiSearchOptions } from './xivapi-search-options';
+export * from './schema/index';

src/model/schema/character/character-response.ts

@@ -0,0 +1,24 @@
+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;
+}

src/model/schema/character/character-verification.ts

@@ -0,0 +1,5 @@
+export interface CharacterVerification {
+    ID: number;
+    VerificationToken: string;
+    VerificationTokenPass: boolean;
+}

src/model/schema/character/character.ts

@@ -0,0 +1,31 @@
+import { ClassJob } from './class-job';
+import { GearSet } from './gear-set';
+import { GrandCompany } from './grand-company';
+
+export interface Character {
+    ActiveClassJob: ClassJob;
+    Added: number;
+    Avatar: string;
+    Bio: string;
+    ClassJobs: { [index: string]: ClassJob };
+    FreeCompanyId: number;
+    GearSet: GearSet;
+    Gender: 1 | 2;
+    GrandCompany: GrandCompany;
+    GuardianDeity: number;
+    ID: number;
+    Minions: number[];
+    Mounts: number[];
+    Name: string;
+    Nameday: string;
+    Portrait: string;
+    PvPTeam: null;
+    Race: number;
+    Server: string;
+    Title: number;
+    Town: number;
+    Tribe: number;
+    Updated: number;
+    VerificationToken: string;
+    VerificationTokenPass: boolean;
+}

src/model/schema/character/class-job.ts

@@ -0,0 +1,8 @@
+export interface ClassJob {
+    ClassID: number;
+    ExpLevel: number;
+    ExpLevelMax: number;
+    ExpLevelTogo: number;
+    JobID: number;
+    Level: number;
+}

src/model/schema/character/gear-details.ts

@@ -0,0 +1,17 @@
+import { GearPiece } from './gear-piece';
+
+export interface GearDetails {
+    Body: GearPiece;
+    Bracelets: GearPiece;
+    Earrings: GearPiece;
+    Feet: GearPiece;
+    Hands: GearPiece;
+    Head: GearPiece;
+    Legs: GearPiece;
+    MainHand: GearPiece;
+    Necklace: GearPiece;
+    Ring1: GearPiece;
+    Ring2: GearPiece;
+    SoulCrystal: GearPiece;
+    Waist: GearPiece;
+}

src/model/schema/character/gear-piece.ts

@@ -0,0 +1,7 @@
+export interface GearPiece {
+    Creator: any; // Typed to any for now as I don't have more details, didn't have this information on my char.
+    Dye: any; // Typed to any for now as I don't have more details, didn't have this information on my char.
+    ID: number;
+    Materia: any[]; // Typed to any for now as I don't have more details, didn't have this information on my char.
+    Mirage: any; // Typed to any for now as I don't have more details, didn't have this information on my char.
+}

src/model/schema/character/gear-set.ts

@@ -0,0 +1,10 @@
+import { GearDetails } from './gear-details';
+
+export interface GearSet {
+    Attributes: { [index: string]: number };
+    ClassID: number;
+    Gear: GearDetails;
+    GearKey: string;
+    JobID: number;
+    Level: number;
+}

src/model/schema/character/grand-company.ts

@@ -0,0 +1,4 @@
+export interface GrandCompany {
+    NameID: number;
+    RankID: number;
+}

src/model/schema/character/index.ts

@@ -0,0 +1,8 @@
+export * from './character';
+export * from './character-response';
+export * from './character-verification';
+export * from './class-job';
+export * from './gear-details';
+export * from './gear-piece';
+export * from './gear-set';
+export * from './grand-company';